Generated on Fri Oct 19 11:26:21 2018 for Gecode by doxygen 1.6.3

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

Finite integer set variable implementation. More...

#include <var-imp.hpp>

List of all members.

Protected Member Functions

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

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 (unsigned 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 schedule=true)
 Subscribe propagator p with propagation condition pc to variable.
void reschedule (Space &home, Propagator &p, PropCond pc)
 Re-schedule propagator p with propagation condition pc.
void subscribe (Space &home, Advisor &a, bool fail)
 Subscribe advisor a to variable.

Cloning



SetVarImpcopy (Space &home)
 Return copy of this variable.

Delta information for advisors



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

Detailed Description

Finite integer set variable implementation.

Definition at line 430 of file var-imp.hpp.


Constructor & Destructor Documentation

Gecode::Set::SetVarImp::SetVarImp ( Space home,
SetVarImp x 
) [inline, protected]

Constructor for cloning x.

Definition at line 117 of file set.cpp.

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

Initialize with empty lower and full upper bound.

Definition at line 48 of file set.hpp.

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 55 of file set.hpp.

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 64 of file set.hpp.

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 74 of file set.hpp.

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 84 of file set.hpp.


Member Function Documentation

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

Return current cardinality minimum.

Definition at line 99 of file set.hpp.

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

Return current cardinality maximum.

Definition at line 102 of file set.hpp.

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

Return minimum of the least upper bound.

Definition at line 111 of file set.hpp.

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

Return maximum of the least upper bound.

Definition at line 114 of file set.hpp.

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

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

Definition at line 117 of file set.hpp.

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

Return minimum of the greatest lower bound.

Definition at line 120 of file set.hpp.

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

Return maximum of the greatest lower bound.

Definition at line 123 of file set.hpp.

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

Return the size of the greatest lower bound.

Definition at line 126 of file set.hpp.

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

Return the size of the least upper bound.

Definition at line 129 of file set.hpp.

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

Test whether variable is assigned.

Definition at line 94 of file set.hpp.

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

Test whether n is contained in greatest lower bound.

Definition at line 105 of file set.hpp.

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

Test whether n is not contained in least upper bound.

Definition at line 108 of file set.hpp.

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

Include n in the greatest lower bound.

Definition at line 287 of file set.hpp.

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 272 of file set.hpp.

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

Exclude n from the least upper bound.

Definition at line 361 of file set.hpp.

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 346 of file set.hpp.

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

Exclude everything but n from the least upper bound.

Definition at line 206 of file set.hpp.

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 181 of file set.hpp.

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

Restrict cardinality to be at least n.

Definition at line 161 of file set.hpp.

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

Restrict cardinality to be at most n.

Definition at line 171 of file set.hpp.

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 292 of file set.hpp.

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 367 of file set.hpp.

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 212 of file set.hpp.

void Gecode::Set::SetVarImp::subscribe ( Space home,
Propagator p,
PropCond  pc,
bool  schedule = true 
)

Subscribe propagator p with propagation condition pc to variable.

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

Definition at line 140 of file set.cpp.

void Gecode::Set::SetVarImp::reschedule ( Space home,
Propagator p,
PropCond  pc 
)

Re-schedule propagator p with propagation condition pc.

Definition at line 149 of file set.cpp.

void Gecode::Set::SetVarImp::subscribe ( Space home,
Advisor a,
bool  fail 
)

Subscribe advisor a to variable.

The advisor a is only subscribed if assigned is false.

If fail is true, the advisor a is also run when a variable operation triggers failure. This feature is undocumented.

Definition at line 145 of file set.cpp.

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

Return copy of this variable.

Definition at line 424 of file set.hpp.

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

Return minimum value just pruned from glb.

Definition at line 136 of file set.hpp.

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

Return maximum value just pruned from glb.

Definition at line 140 of file set.hpp.

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

Test whether arbitrary values got pruned from glb.

Definition at line 144 of file set.hpp.

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

Return minimum value just pruned from lub.

Definition at line 148 of file set.hpp.

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

Return maximum value just pruned from lub.

Definition at line 152 of file set.hpp.

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

Test whether arbitrary values got pruned from lub.

Definition at line 156 of file set.hpp.


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