Generated on Fri Oct 19 11:25:54 2018 for Gecode by doxygen 1.6.3

Gecode::SetVar Class Reference
[Set variables]

Set variables More...

#include <set.hh>

List of all members.

Related Functions

(Note that these are not member functions.)



template<class Char , class Traits >
std::basic_ostream< Char,
Traits > & 
operator<< (std::basic_ostream< Char, Traits > &os, const SetVar &x)
 Print set variable x.

Constructors and initialization



 SetVar (void)
 Default constructor.
 SetVar (const SetVar &y)
 Initialize from set variable y.
 SetVar (const Set::SetView &y)
 Initialize from set view y.
 SetVar (Space &home)
 Initialize variable with empty greatest lower and full least upper bound.
 SetVar (Space &home, int glbMin, int glbMax, int lubMin, int lubMax, unsigned int cardMin=0, unsigned int cardMax=Set::Limits::card)
 Initialize variable with given bounds and cardinality.
 SetVar (Space &home, const IntSet &glbD, int lubMin, int lubMax, unsigned int cardMin=0, unsigned int cardMax=Set::Limits::card)
 Initialize variable with given bounds and cardinality.
 SetVar (Space &home, int glbMin, int glbMax, const IntSet &lubD, unsigned int cardMin=0, unsigned int cardMax=Set::Limits::card)
 Initialize variable with given bounds and cardinality.
 SetVar (Space &home, const IntSet &glbD, const IntSet &lubD, unsigned int cardMin=0, unsigned int cardMax=Set::Limits::card)
 Initialize variable with given bounds and cardinality.

Value access



unsigned int glbSize (void) const
 Return number of elements in the greatest lower bound.
unsigned int lubSize (void) const
 Return number of elements in the least upper bound.
unsigned int unknownSize (void) const
 Return number of unknown elements (elements in lub but not in glb).
unsigned int cardMin (void) const
 Return cardinality minimum.
unsigned int cardMax (void) const
 Return cardinality maximum.
int lubMin (void) const
 Return minimum element of least upper bound.
int lubMax (void) const
 Return maximum element of least upper bound.
int glbMin (void) const
 Return minimum element of greatest lower bound.
int glbMax (void) const
 Return maximum of greatest lower bound.

Domain tests



bool contains (int i) const
 Test whether i is in greatest lower bound.
bool notContains (int i) const
 Test whether i is not in the least upper bound.

Detailed Description

Set variables

Definition at line 127 of file set.hh.


Constructor & Destructor Documentation

Gecode::SetVar::SetVar ( void   )  [inline]

Default constructor.

Definition at line 46 of file set.hpp.

Gecode::SetVar::SetVar ( const SetVar y  )  [inline]

Initialize from set variable y.

Definition at line 49 of file set.hpp.

Gecode::SetVar::SetVar ( const Set::SetView y  )  [inline]

Initialize from set view y.

Definition at line 53 of file set.hpp.

Gecode::SetVar::SetVar ( Space home  ) 

Initialize variable with empty greatest lower and full least upper bound.

Definition at line 43 of file set.cpp.

Gecode::SetVar::SetVar ( Space home,
int  glbMin,
int  glbMax,
int  lubMin,
int  lubMax,
unsigned int  cardMin = 0,
unsigned int  cardMax = Set::Limits::card 
)

Initialize variable with given bounds and cardinality.

The variable is created with greatest lower bound $\{\mathit{glbMin},\dots,\mathit{glbMax}\}$, least upper bound $\{\mathit{lubMin},\dots,\mathit{lubMax}\}$, and cardinality minimum cardMin and maximum cardMax. The following exceptions might be thrown:

Definition at line 46 of file set.cpp.

Gecode::SetVar::SetVar ( Space home,
const IntSet glbD,
int  lubMin,
int  lubMax,
unsigned int  cardMin = 0,
unsigned int  cardMax = Set::Limits::card 
)

Initialize variable with given bounds and cardinality.

The variable is created with greatest lower bound glbD, least upper bound $\{\mathit{lubMin},\dots,\mathit{lubMax}\}$, and cardinality minimum cardMin and maximum cardMax. The following exceptions might be thrown:

Definition at line 61 of file set.cpp.

Gecode::SetVar::SetVar ( Space home,
int  glbMin,
int  glbMax,
const IntSet lubD,
unsigned int  cardMin = 0,
unsigned int  cardMax = Set::Limits::card 
)

Initialize variable with given bounds and cardinality.

The variable is created with greatest lower bound $\{\mathit{glbMin},\dots,\mathit{glbMax}\}$, least upper bound lubD, and cardinality minimum cardMin and maximum cardMax. The following exceptions might be thrown:

Definition at line 74 of file set.cpp.

Gecode::SetVar::SetVar ( Space home,
const IntSet glbD,
const IntSet lubD,
unsigned int  cardMin = 0,
unsigned int  cardMax = Set::Limits::card 
)

Initialize variable with given bounds and cardinality.

The variable is created with greatest lower bound glbD, least upper bound lubD, and cardinality minimum cardMin and maximum cardMax. The following exceptions might be thrown:

Definition at line 89 of file set.cpp.


Member Function Documentation

unsigned int Gecode::SetVar::glbSize ( void   )  const [inline]

Return number of elements in the greatest lower bound.

Definition at line 63 of file set.hpp.

unsigned int Gecode::SetVar::lubSize ( void   )  const [inline]

Return number of elements in the least upper bound.

Definition at line 66 of file set.hpp.

unsigned int Gecode::SetVar::unknownSize ( void   )  const [inline]

Return number of unknown elements (elements in lub but not in glb).

Definition at line 69 of file set.hpp.

unsigned int Gecode::SetVar::cardMin ( void   )  const [inline]

Return cardinality minimum.

Definition at line 78 of file set.hpp.

unsigned int Gecode::SetVar::cardMax ( void   )  const [inline]

Return cardinality maximum.

Definition at line 81 of file set.hpp.

int Gecode::SetVar::lubMin ( void   )  const [inline]

Return minimum element of least upper bound.

Definition at line 84 of file set.hpp.

int Gecode::SetVar::lubMax ( void   )  const [inline]

Return maximum element of least upper bound.

Definition at line 87 of file set.hpp.

int Gecode::SetVar::glbMin ( void   )  const [inline]

Return minimum element of greatest lower bound.

Definition at line 90 of file set.hpp.

int Gecode::SetVar::glbMax ( void   )  const [inline]

Return maximum of greatest lower bound.

Definition at line 93 of file set.hpp.

bool Gecode::SetVar::contains ( int  i  )  const [inline]

Test whether i is in greatest lower bound.

Definition at line 72 of file set.hpp.

bool Gecode::SetVar::notContains ( int  i  )  const [inline]

Test whether i is not in the least upper bound.

Definition at line 75 of file set.hpp.


Friends And Related Function Documentation

template<class Char , class Traits >
std::basic_ostream< Char, Traits > & operator<< ( std::basic_ostream< Char, Traits > &  os,
const SetVar x 
) [related]

Print set variable x.

Definition at line 38 of file print.hpp.


The documentation for this class was generated from the following files: