Generated on Mon Aug 25 11:35:53 2008 for Gecode by doxygen 1.5.6
Gecode::Set::SetVarImp

Gecode::Set::SetVarImp Class Reference
[Other available functionality]

List of all members.

Detailed Description

Finite integer set variable implementation.

Definition at line 506 of file var-imp.icc.


Constructors and initialization

 SetVarImp (Space *home)
 Initialize with empty lower and full upper bound.
 SetVarImp (Space *home, int glbMin, int glbMax, int lubMin, int lubMax, unsigned int cardMin=0, unsigned int cardMax=Limits::card)
 Initialize with given bounds and cardinality.
 SetVarImp (Space *home, const IntSet &glbD, int lubMin, int lubMax, unsigned int cardMin, unsigned int cardMax)
 Initialize with given bounds and cardinality.
 SetVarImp (Space *home, int glbMin, int glbMax, const IntSet &lubD, unsigned int cardMin, unsigned int cardMax)
 Initialize with given bounds and cardinality.
 SetVarImp (Space *home, const IntSet &glbD, const IntSet &lubD, unsigned int cardMin, unsigned int cardMax)
 Initialize with given bounds and cardinality.

Value access

unsigned int cardMin (void) const
 Return current cardinality minimum.
unsigned int cardMax (void) const
 Return current cardinality maximum.
int lubMin (void) const
 Return minimum of the least upper bound.
int lubMax (void) const
 Return maximum of the least upper bound.
int lubMinN (int n) const
 Return n -th smallest element in the least upper bound.
int glbMin (void) const
 Return minimum of the greatest lower bound.
int glbMax (void) const
 Return maximum of the greatest lower bound.
unsigned int glbSize (void) const
 Return the size of the greatest lower bound.
unsigned int lubSize (void) const
 Return the size of the least upper bound.

Domain tests

bool assigned (void) const
 Test whether variable is assigned.
bool knownIn (int n) const
 Test whether n is contained in greatest lower bound.
bool knownOut (int) const
 Test whether n is not contained in least upper bound.

Domain update by value

ModEvent include (Space *home, int n)
 Include n in the greatest lower bound.
ModEvent include (Space *home, int i, int j)
 Include the range $\{i,\dots,j\}$ in the greatest lower bound.
ModEvent exclude (Space *home, int n)
 Exclude n from the least upper bound.
ModEvent exclude (Space *home, int i, int j)
 Exclude the range $\{i,\dots,j\}$ from the least upper bound.
ModEvent intersect (Space *home, int n)
 Exclude everything but n from the least upper bound.
ModEvent intersect (Space *home, int i, int j)
 Exclude everything but the range $\{i,\dots,j\}$ from the least upper bound.
ModEvent cardMin (Space *home, unsigned int n)
 Restrict cardinality to be at least n.
ModEvent cardMax (Space *home, unsigned int n)
 Restrict cardinality to be at most n.

Domain update by range iterator

template<class I>
ModEvent includeI (Space *home, I &i)
 Include set described by i in the greatest lower bound.
template<class I>
ModEvent excludeI (Space *home, I &i)
 Exclude set described by i from the least upper bound.
template<class I>
ModEvent intersectI (Space *home, I &i)
 Exclude everything but set described by i from the least upper bound.

Dependencies

void subscribe (Space *home, Propagator *p, PropCond pc, bool process=true)
 Subscribe propagator p with propagation condition pc to variable.
void cancel (Space *home, Propagator *p, PropCond pc)
 Cancel subscription of propagator p with propagation condition pc.
void subscribe (Space *home, Advisor *a)
 Subscribe advisor a to variable.
void cancel (Space *home, Advisor *a)
 Cancel subscription of advisor a.

Cloning

SetVarImp * copy (Space *home, bool share)
 Return copy of this variable.

Reflection

Reflection::Arg * spec (const Space *home, Reflection::VarMap &m) const
 Return specification.
static VarImpBase * create (Space *home, Reflection::VarSpec &spec)
 Create variable implementation from specification.
static void constrain (Space *home, VarImpBase *v, Reflection::VarSpec &spec)
 Constrain variable implementation using specification.

Delta information for advisors

int glbMin (const Delta *d) const
 Return minimum value just pruned from glb.
int glbMax (const Delta *d) const
 Return maximum value just pruned from glb.
bool glbAny (const Delta *d) const
 Test whether arbitrary values got pruned from glb.
int lubMin (const Delta *d) const
 Return minimum value just pruned from lub.
int lubMax (const Delta *d) const
 Return maximum value just pruned from lub.
bool lubAny (const Delta *d) const
 Test whether arbitrary values got pruned from lub.
static ModEvent modevent (const Delta *d)
 Return modification event.

Protected Member Functions

 SetVarImp (Space *home, bool share, SetVarImp &x)
 Constructor for cloning x.

Constructor & Destructor Documentation

Gecode::Set::SetVarImp::SetVarImp ( Space *  home,
bool  share,
SetVarImp &  x 
) [inline, protected]

Constructor for cloning x.

Definition at line 121 of file set.cc.

Gecode::Set::SetVarImp::SetVarImp ( Space *  home  )  [inline]

Initialize with empty lower and full upper bound.

Definition at line 52 of file set.icc.

Gecode::Set::SetVarImp::SetVarImp ( Space *  home,
int  glbMin,
int  glbMax,
int  lubMin,
int  lubMax,
unsigned int  cardMin = 0,
unsigned int  cardMax = Limits::card 
) [inline]

Initialize with given bounds and cardinality.

Creates a set variable $s$ with $\mathit{glb}(s)=\{\mathit{glbMin},\dots,\mathit{glbMax}\}$, $\mathit{lub}(s)=\{\mathit{lubMin},\dots,\mathit{lubMax}\}$, and $\mathit{cardMin}\leq |s|\leq\mathit{cardMax}$

Definition at line 60 of file set.icc.

Gecode::Set::SetVarImp::SetVarImp ( Space *  home,
const IntSet &  glbD,
int  lubMin,
int  lubMax,
unsigned int  cardMin,
unsigned int  cardMax 
) [inline]

Initialize with given bounds and cardinality.

Creates a set variable $s$ with $\mathit{glb}(s)=\mathit{glbD}$, $\mathit{lub}(s)=\{\mathit{lubMin},\dots,\mathit{lubMax}\}$, and $\mathit{cardMin}\leq |s|\leq\mathit{cardMax}$

Definition at line 69 of file set.icc.

Gecode::Set::SetVarImp::SetVarImp ( Space *  home,
int  glbMin,
int  glbMax,
const IntSet &  lubD,
unsigned int  cardMin,
unsigned int  cardMax 
) [inline]

Initialize with given bounds and cardinality.

Creates a set variable $s$ with $\mathit{glb}(s)=\{\mathit{glbMin},\dots,\mathit{glbMax}\}$, $\mathit{lub}(s)=\mathit{lubD}$, and $\mathit{cardMin}\leq |s|\leq\mathit{cardMax}$

Definition at line 79 of file set.icc.

Gecode::Set::SetVarImp::SetVarImp ( Space *  home,
const IntSet &  glbD,
const IntSet &  lubD,
unsigned int  cardMin,
unsigned int  cardMax 
) [inline]

Initialize with given bounds and cardinality.

Creates a set variable $s$ with $\mathit{glb}(s)=\mathit{glbD}$, $\mathit{lub}(s)=\mathit{lubD}$, and $\mathit{cardMin}\leq |s|\leq\mathit{cardMax}$

Definition at line 89 of file set.icc.

Member Function Documentation

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

Return current cardinality minimum.

Definition at line 104 of file set.icc.

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

Return current cardinality maximum.

Definition at line 107 of file set.icc.

int Gecode::Set::SetVarImp::lubMin ( void   )  const [inline]

Return minimum of the least upper bound.

Definition at line 116 of file set.icc.

int Gecode::Set::SetVarImp::lubMax ( void   )  const [inline]

Return maximum of the least upper bound.

Definition at line 119 of file set.icc.

int Gecode::Set::SetVarImp::lubMinN ( int  n  )  const [inline]

Return n -th smallest element in the least upper bound.

Definition at line 122 of file set.icc.

int Gecode::Set::SetVarImp::glbMin ( void   )  const [inline]

Return minimum of the greatest lower bound.

Definition at line 125 of file set.icc.

int Gecode::Set::SetVarImp::glbMax ( void   )  const [inline]

Return maximum of the greatest lower bound.

Definition at line 128 of file set.icc.

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

Return the size of the greatest lower bound.

Definition at line 131 of file set.icc.

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

Return the size of the least upper bound.

Definition at line 134 of file set.icc.

bool Gecode::Set::SetVarImp::assigned ( void   )  const [inline]

Test whether variable is assigned.

Definition at line 99 of file set.icc.

bool Gecode::Set::SetVarImp::knownIn ( int  n  )  const [inline]

Test whether n is contained in greatest lower bound.

Definition at line 110 of file set.icc.

bool Gecode::Set::SetVarImp::knownOut ( int  i  )  const [inline]

Test whether n is not contained in least upper bound.

Definition at line 113 of file set.icc.

ModEvent Gecode::Set::SetVarImp::include ( Space *  home,
int  n 
) [inline]

Include n in the greatest lower bound.

Definition at line 294 of file set.icc.

ModEvent Gecode::Set::SetVarImp::include ( Space *  home,
int  i,
int  j 
) [inline]

Include the range $\{i,\dots,j\}$ in the greatest lower bound.

Definition at line 281 of file set.icc.

ModEvent Gecode::Set::SetVarImp::exclude ( Space *  home,
int  n 
) [inline]

Exclude n from the least upper bound.

Definition at line 366 of file set.icc.

ModEvent Gecode::Set::SetVarImp::exclude ( Space *  home,
int  i,
int  j 
) [inline]

Exclude the range $\{i,\dots,j\}$ from the least upper bound.

Definition at line 353 of file set.icc.

ModEvent Gecode::Set::SetVarImp::intersect ( Space *  home,
int  n 
) [inline]

Exclude everything but n from the least upper bound.

Definition at line 215 of file set.icc.

ModEvent Gecode::Set::SetVarImp::intersect ( Space *  home,
int  i,
int  j 
) [inline]

Exclude everything but the range $\{i,\dots,j\}$ from the least upper bound.

Definition at line 190 of file set.icc.

ModEvent Gecode::Set::SetVarImp::cardMin ( Space *  home,
unsigned int  n 
) [inline]

Restrict cardinality to be at least n.

Definition at line 170 of file set.icc.

ModEvent Gecode::Set::SetVarImp::cardMax ( Space *  home,
unsigned int  n 
) [inline]

Restrict cardinality to be at most n.

Definition at line 180 of file set.icc.

template<class I>
ModEvent Gecode::Set::SetVarImp::includeI ( Space *  home,
I &  i 
) [inline]

Include set described by i in the greatest lower bound.

Definition at line 299 of file set.icc.

template<class I>
ModEvent Gecode::Set::SetVarImp::excludeI ( Space *  home,
I &  i 
) [inline]

Exclude set described by i from the least upper bound.

Definition at line 372 of file set.icc.

template<class I>
ModEvent Gecode::Set::SetVarImp::intersectI ( Space *  home,
I &  i 
) [inline]

Exclude everything but set described by i from the least upper bound.

Definition at line 221 of file set.icc.

void Gecode::Set::SetVarImp::subscribe ( Space *  home,
Propagator *  p,
PropCond  pc,
bool  process = true 
) [inline]

Subscribe propagator p with propagation condition pc to variable.

In case process is false, the propagator is just subscribed but not processed for execution (this must be used when creating subscriptions during propagation).

Definition at line 514 of file set.icc.

void Gecode::Set::SetVarImp::cancel ( Space *  home,
Propagator *  p,
PropCond  pc 
) [inline]

Cancel subscription of propagator p with propagation condition pc.

Definition at line 518 of file set.icc.

void Gecode::Set::SetVarImp::subscribe ( Space *  home,
Advisor *  a 
) [inline]

Subscribe advisor a to variable.

Definition at line 522 of file set.icc.

void Gecode::Set::SetVarImp::cancel ( Space *  home,
Advisor *  a 
) [inline]

Cancel subscription of advisor a.

Definition at line 526 of file set.icc.

SetVarImp * Gecode::Set::SetVarImp::copy ( Space *  home,
bool  share 
) [inline]

Return copy of this variable.

Definition at line 429 of file set.icc.

Reflection::Arg * Gecode::Set::SetVarImp::spec ( const Space *  home,
Reflection::VarMap &  m 
) const

Return specification.

Definition at line 139 of file set.cc.

VarImpBase * Gecode::Set::SetVarImp::create ( Space *  home,
Reflection::VarSpec &  spec 
) [static]

Create variable implementation from specification.

Definition at line 181 of file set.cc.

void Gecode::Set::SetVarImp::constrain ( Space *  home,
VarImpBase *  v,
Reflection::VarSpec &  spec 
) [static]

Constrain variable implementation using specification.

Definition at line 193 of file set.cc.

ModEvent Gecode::Set::SetVarImp::modevent ( const Delta *  d  )  [inline, static]

Return modification event.

Definition at line 141 of file set.icc.

int Gecode::Set::SetVarImp::glbMin ( const Delta *  d  )  const [inline]

Return minimum value just pruned from glb.

Definition at line 145 of file set.icc.

int Gecode::Set::SetVarImp::glbMax ( const Delta *  d  )  const [inline]

Return maximum value just pruned from glb.

Definition at line 149 of file set.icc.

bool Gecode::Set::SetVarImp::glbAny ( const Delta *  d  )  const [inline]

Test whether arbitrary values got pruned from glb.

Definition at line 153 of file set.icc.

int Gecode::Set::SetVarImp::lubMin ( const Delta *  d  )  const [inline]

Return minimum value just pruned from lub.

Definition at line 157 of file set.icc.

int Gecode::Set::SetVarImp::lubMax ( const Delta *  d  )  const [inline]

Return maximum value just pruned from lub.

Definition at line 161 of file set.icc.

bool Gecode::Set::SetVarImp::lubAny ( const Delta *  d  )  const [inline]

Test whether arbitrary values got pruned from lub.

Definition at line 165 of file set.icc.

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