Gecode::SetVar Class Reference
[Set variables]

#include <set.hh>

Inherits Gecode::VarBase< Gecode::Set::SetVarImp >.

List of all members.

---

Detailed Description

Set variables

Definition at line 122 of file set.hh.

Constructors and initialization
	SetVar (void)
	Default constructor.
	SetVar (const SetVar &x0)
	Initialize from set variable x0.
	SetVar (const Set::SetView &x0)
	Initialize from set view x0.
	SetVar (const Reflection::Var &x0)
	Initialize from reflection variable x0.
	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.
bool	assigned (void) const
	Test whether this variable is assigned.
Cloning
void	update (Space *home, bool, SetVar &x)
	Update this variable to be a clone of variable x.
Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &, const Gecode::SetVar &x)
	Print set variable x.

---

Constructor & Destructor Documentation

Gecode::SetVar::SetVar

(

void

)

[inline]

Default constructor.

Definition at line 50 of file set.icc.

Gecode::SetVar::SetVar

(

const SetVar &

x0

)

[inline]

Initialize from set variable x0.

Definition at line 53 of file set.icc.

Gecode::SetVar::SetVar

(

const Set::SetView &

x0

)

[inline]

Initialize from set view x0.

Definition at line 57 of file set.icc.

Gecode::SetVar::SetVar

(

const Reflection::Var &

x0

)

[inline]

Initialize from reflection variable x0.

Definition at line 61 of file set.icc.

Gecode::SetVar::SetVar

(

Space *

home

)

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

Definition at line 47 of file set.cc.

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 , least upper bound , and cardinality minimum cardMin and maximum cardMax. The following exceptions might be thrown:

• If the bounds are no legal set bounds (between Set::Limits::min and Set::Limits::max), an exception of type Gecode::Set::OutOfLimits is thrown.
• If the cardinality is greater than Set::Limits::max_set_size, an exception of type Gecode::Set::OutOfLimits is thrown.
• If minCard > maxCard, an exception of type Gecode::Set::VariableEmptyDomain is thrown.

Definition at line 50 of file set.cc.

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 , and cardinality minimum cardMin and maximum cardMax. The following exceptions might be thrown:

• If the bounds are no legal set bounds (between Set::Limits::min and Set::Limits::max), an exception of type Gecode::Set::OutOfLimits is thrown.
• If the cardinality is greater than Set::Limits::max_set_size, an exception of type Gecode::Set::OutOfLimits is thrown.
• If minCard > maxCard, an exception of type Gecode::Set::VariableEmptyDomain is thrown.

Definition at line 64 of file set.cc.

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 , least upper bound lubD, and cardinality minimum cardMin and maximum cardMax. The following exceptions might be thrown:

• If the bounds are no legal set bounds (between Set::Limits::min and Set::Limits::max), an exception of type Gecode::Set::OutOfLimits is thrown.
• If the cardinality is greater than Set::Limits::max_set_size, an exception of type Gecode::Set::OutOfLimits is thrown.
• If minCard > maxCard, an exception of type Gecode::Set::VariableEmptyDomain is thrown.

Definition at line 78 of file set.cc.

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:

• If the bounds are no legal set bounds (between Set::Limits::min and Set::Limits::max), an exception of type Gecode::Set::OutOfLimits is thrown.
• If the cardinality is greater than Set::Limits::max_set_size, an exception of type Gecode::Set::OutOfLimits is thrown.
• If minCard > maxCard, an exception of type Gecode::Set::VariableEmptyDomain is thrown.

Definition at line 90 of file set.cc.

---

Member Function Documentation

unsigned int Gecode::SetVar::glbSize

(

void

)

const [inline]

Return number of elements in the greatest lower bound.

Definition at line 104 of file set.icc.

unsigned int Gecode::SetVar::lubSize

(

void

)

const [inline]

Return number of elements in the least upper bound.

Definition at line 107 of file set.icc.

unsigned int Gecode::SetVar::unknownSize

(

void

)

const [inline]

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

Definition at line 110 of file set.icc.

unsigned int Gecode::SetVar::cardMin

(

void

)

const [inline]

Return cardinality minimum.

Definition at line 122 of file set.icc.

unsigned int Gecode::SetVar::cardMax

(

void

)

const [inline]

Return cardinality maximum.

Definition at line 125 of file set.icc.

int Gecode::SetVar::lubMin

(

void

)

const [inline]

Return minimum element of least upper bound.

Definition at line 128 of file set.icc.

int Gecode::SetVar::lubMax

(

void

)

const [inline]

Return maximum element of least upper bound.

Definition at line 131 of file set.icc.

int Gecode::SetVar::glbMin

(

void

)

const [inline]

Return minimum element of greatest lower bound.

Definition at line 134 of file set.icc.

int Gecode::SetVar::glbMax

(

void

)

const [inline]

Return maximum of greatest lower bound.

Definition at line 137 of file set.icc.

bool Gecode::SetVar::contains

(

int

i

)

const [inline]

Test whether i is in greatest lower bound.

Definition at line 116 of file set.icc.

bool Gecode::SetVar::notContains

(

int

i

)

const [inline]

Test whether i is not in the least upper bound.

Definition at line 119 of file set.icc.

bool Gecode::SetVar::assigned

(

void

)

const [inline]

Test whether this variable is assigned.

Definition at line 113 of file set.icc.

void Gecode::SetVar::update	(	Space *	home,
		bool	share,
		SetVar &	x
	)			[inline]

Update this variable to be a clone of variable x.

Definition at line 145 of file set.icc.

---

Friends And Related Function Documentation

std::ostream & operator<<	(	std::ostream &	,
		const Gecode::SetVar &	x
	)			[related]

Print set variable x.

Definition at line 1446 of file view.icc.

---

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

• gecode/set.hh (Revision: 7339)
• gecode/set/var/set.cc (Revision: 6274)
• gecode/set/var/set.icc (Revision: 7288)