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

Gecode::Set::SingletonView Class Reference
[Set views]

Inherits DerivedViewBase< Gecode::Int::IntView >.

List of all members.

Detailed Description

Singleton set view.

A singleton set view $s$ for an integer view $x$ provides operations such that $s$ behaves like the singleton set $\{x\}$.

Definition at line 799 of file view.icc.


Constructors and initialization

 SingletonView (void)
 Default constructor.
 SingletonView (Gecode::Int::IntView &x)
 Initialize with integer view x.
 SingletonView (Space *home, const Reflection::VarMap &vars, Reflection::Arg *arg)
 Initialize from specification.

Value access

unsigned int cardMin (void) const
 Return minimum cardinality.
unsigned int cardMax (void) const
 Return maximum cardinality.
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 of 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 number of elements in the greatest lower bound.
unsigned int lubSize (void) const
 Return the number of elements in the least upper bound.
unsigned int unknownSize (void) const
 Return the number of unknown elements.

Domain tests

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

Domain update by value

ModEvent cardMin (Space *home, unsigned int m)
 Restrict cardinality to be greater than or equal to m.
ModEvent cardMax (Space *home, unsigned int m)
 Restrict cardinality to be less than or equal to m.
ModEvent include (Space *home, int i, int j)
 Update greatest lower bound to include all elements between and including i and j.
ModEvent exclude (Space *home, int i, int j)
 Restrict least upper bound to not contain all elements between and including i and j.
ModEvent include (Space *home, int i)
 Update greatest lower bound to contain i.
ModEvent exclude (Space *home, int i)
 Restrict least upper bound to not contain i.
ModEvent intersect (Space *home, int i, int j)
 Update least upper bound to contain at most all elements between and including i and j.
ModEvent intersect (Space *home, int i)
 Update least upper bound to contain at most the element i.

Domain update by range iterator

template<class I>
ModEvent excludeI (Space *home, I &i)
 Remove range sequence described by i from least upper bound.
template<class I>
ModEvent includeI (Space *home, I &i)
 Include range sequence described by i in greatest lower bound.
template<class I>
ModEvent intersectI (Space *home, I &iter)
 Intersect least upper bound with range sequence described by i.

Dependencies

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

Cloning

void update (Space *home, bool share, SingletonView &x)
 Update this view to be a clone of view x.

Reflection

Reflection::Arg * spec (const Space *home, Reflection::VarMap &m) const
 Return specification for this view, using variable map m.
static Support::Symbol type (void)
 Return specification for this view, using variable map m.

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.

View-dependent propagator support

static void schedule (Space *home, Propagator *p, ModEvent me)
 Schedule propagator p with modification event me.
static ModEvent me (ModEventDelta med)
 Return modification event for view type in med.
static ModEventDelta med (ModEvent)
 Translate modification event me to modification event delta for view.

View comparison

bool same (const Set::SingletonView &x, const Set::SingletonView &y)
 Test whether views x and y are the same.
bool before (const Set::SingletonView &x, const Set::SingletonView &y)
 Test whether view x comes before y (arbitrary order).

Static Protected Member Functions

static PropCond pc_settoint (PropCond pc)
 Convert set variable PropCond pc to a PropCond for integer variables.
static ModEvent me_inttoset (ModEvent me)
 Convert integer variable ModEvent me to a ModEvent for set variables.
static ModEvent me_settoint (ModEvent me)
 Convert set variable ModEvent me to a ModEvent for integer variables.

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &, const Gecode::Set::SingletonView &)
 Print singelton set view.

Constructor & Destructor Documentation

Gecode::Set::SingletonView::SingletonView ( void   )  [inline]

Default constructor.

Definition at line 47 of file singleton.icc.

Gecode::Set::SingletonView::SingletonView ( Gecode::Int::IntView &  x  )  [inline]

Initialize with integer view x.

Definition at line 50 of file singleton.icc.

Gecode::Set::SingletonView::SingletonView ( Space *  home,
const Reflection::VarMap &  vars,
Reflection::Arg *  arg 
) [inline]

Initialize from specification.

Definition at line 54 of file singleton.icc.

Member Function Documentation

PropCond Gecode::Set::SingletonView::pc_settoint ( PropCond  pc  )  [inline, static, protected]

Convert set variable PropCond pc to a PropCond for integer variables.

Definition at line 61 of file singleton.icc.

ModEvent Gecode::Set::SingletonView::me_inttoset ( ModEvent  me  )  [inline, static, protected]

Convert integer variable ModEvent me to a ModEvent for set variables.

Definition at line 73 of file singleton.icc.

ModEvent Gecode::Set::SingletonView::me_settoint ( ModEvent  me  )  [inline, static, protected]

Convert set variable ModEvent me to a ModEvent for integer variables.

Definition at line 89 of file singleton.icc.

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

Return minimum cardinality.

Definition at line 124 of file singleton.icc.

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

Return maximum cardinality.

Definition at line 127 of file singleton.icc.

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

Return minimum of the least upper bound.

Definition at line 130 of file singleton.icc.

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

Return maximum of the least upper bound.

Definition at line 133 of file singleton.icc.

int Gecode::Set::SingletonView::lubMinN ( int  n  )  const

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

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

Return minimum of the greatest lower bound.

Definition at line 136 of file singleton.icc.

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

Return maximum of the greatest lower bound.

Definition at line 140 of file singleton.icc.

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

Return the number of elements in the greatest lower bound.

Definition at line 106 of file singleton.icc.

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

Return the number of elements in the least upper bound.

Definition at line 109 of file singleton.icc.

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

Return the number of unknown elements.

Definition at line 112 of file singleton.icc.

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

Test whether view is assigned.

Definition at line 103 of file singleton.icc.

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

Test whether i is in the greatest lower bound.

Definition at line 117 of file singleton.icc.

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

Test whether i is not in the least upper bound.

Definition at line 121 of file singleton.icc.

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

Restrict cardinality to be greater than or equal to m.

Definition at line 144 of file singleton.icc.

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

Restrict cardinality to be less than or equal to m.

Definition at line 149 of file singleton.icc.

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

Update greatest lower bound to include all elements between and including i and j.

Definition at line 187 of file singleton.icc.

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

Restrict least upper bound to not contain all elements between and including i and j.

Definition at line 192 of file singleton.icc.

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

Update greatest lower bound to contain i.

Definition at line 154 of file singleton.icc.

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

Restrict least upper bound to not contain i.

Definition at line 182 of file singleton.icc.

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

Update least upper bound to contain at most all elements between and including i and j.

Definition at line 164 of file singleton.icc.

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

Update least upper bound to contain at most the element i.

Definition at line 159 of file singleton.icc.

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

Remove range sequence described by i from least upper bound.

Definition at line 210 of file singleton.icc.

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

Include range sequence described by i in greatest lower bound.

Definition at line 215 of file singleton.icc.

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

Intersect least upper bound with range sequence described by i.

Definition at line 231 of file singleton.icc.

void Gecode::Set::SingletonView::schedule ( Space *  home,
Propagator *  p,
ModEvent  me 
) [inline, static]

Schedule propagator p with modification event me.

Definition at line 256 of file singleton.icc.

ModEvent Gecode::Set::SingletonView::me ( ModEventDelta  med  )  [inline, static]

Return modification event for view type in med.

Definition at line 260 of file singleton.icc.

ModEventDelta Gecode::Set::SingletonView::med ( ModEvent  me  )  [inline, static]

Translate modification event me to modification event delta for view.

Definition at line 264 of file singleton.icc.

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

Subscribe propagator p with propagation condition pc to view.

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 236 of file singleton.icc.

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

Cancel subscription of propagator p with propagation condition pc to view.

Definition at line 241 of file singleton.icc.

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

Subscribe advisor a to view.

Definition at line 246 of file singleton.icc.

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

Cancel subscription of advisor a.

Definition at line 250 of file singleton.icc.

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

Update this view to be a clone of view x.

Definition at line 269 of file singleton.icc.

Reflection::Arg * Gecode::Set::SingletonView::spec ( const Space *  home,
Reflection::VarMap &  m 
) const [inline]

Return specification for this view, using variable map m.

Definition at line 274 of file singleton.icc.

Support::Symbol Gecode::Set::SingletonView::type ( void   )  [inline, static]

Return specification for this view, using variable map m.

Definition at line 279 of file singleton.icc.

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

Return modification event.

Definition at line 292 of file singleton.icc.

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

Return minimum value just pruned from glb.

Definition at line 297 of file singleton.icc.

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

Return maximum value just pruned from glb.

Definition at line 300 of file singleton.icc.

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

Test whether arbitrary values got pruned from glb.

Definition at line 303 of file singleton.icc.

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

Return minimum value just pruned from lub.

Definition at line 306 of file singleton.icc.

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

Return maximum value just pruned from lub.

Definition at line 309 of file singleton.icc.

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

Test whether arbitrary values got pruned from lub.

Definition at line 312 of file singleton.icc.

Friends And Related Function Documentation

bool same ( const Set::SingletonView &  x,
const Set::SingletonView &  y 
) [related]

Test whether views x and y are the same.

Definition at line 426 of file singleton.icc.

bool before ( const Set::SingletonView &  x,
const Set::SingletonView &  y 
) [related]

Test whether view x comes before y (arbitrary order).

Definition at line 430 of file singleton.icc.

std::ostream & operator<< ( std::ostream &  ,
const Gecode::Set::SingletonView &   
) [related]

Print singelton set view.

Definition at line 131 of file print.cc.

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