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

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

Singleton set view. More...

#include <view.hpp>

List of all members.

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.)



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

Constructors and initialization



 SingletonView (void)
 Default constructor.
 SingletonView (Gecode::Int::IntView &y)
 Initialize with integer view y.
 SingletonView (const Gecode::IntVar &y)
 Initialize with integer variable y.

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 (unsigned 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 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 schedule=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 reschedule (Space &home, Propagator &p, PropCond pc)
 Re-schedule propagator p with propagation condition pc.
void subscribe (Space &home, Advisor &a)
 Subscribe advisor a to view.
void cancel (Space &home, Advisor &a)
 Cancel subscription of advisor a.

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 (const 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 operator== (const SingletonView &x, const SingletonView &y)
 Test whether views x and y are the same.
bool operator!= (const SingletonView &x, const SingletonView &y)
 Test whether views x and y are the not same.

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 594 of file view.hpp.


Constructor & Destructor Documentation

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

Default constructor.

Definition at line 41 of file singleton.hpp.

Gecode::Set::SingletonView::SingletonView ( Gecode::Int::IntView y  )  [inline]

Initialize with integer view y.

Definition at line 44 of file singleton.hpp.

Gecode::Set::SingletonView::SingletonView ( const Gecode::IntVar y  )  [inline]

Initialize with integer variable y.

Definition at line 48 of file singleton.hpp.


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 52 of file singleton.hpp.

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

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 80 of file singleton.hpp.

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

Return minimum cardinality.

Definition at line 114 of file singleton.hpp.

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

Return maximum cardinality.

Definition at line 117 of file singleton.hpp.

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

Return minimum of the least upper bound.

Definition at line 120 of file singleton.hpp.

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

Return maximum of the least upper bound.

Definition at line 123 of file singleton.hpp.

int Gecode::Set::SingletonView::lubMinN ( unsigned 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 126 of file singleton.hpp.

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

Return maximum of the greatest lower bound.

Definition at line 130 of file singleton.hpp.

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

Return the number of elements in the greatest lower bound.

Definition at line 94 of file singleton.hpp.

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

Return the number of elements in the least upper bound.

Definition at line 99 of file singleton.hpp.

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

Return the number of unknown elements.

Definition at line 102 of file singleton.hpp.

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

Test whether i is in the greatest lower bound.

Definition at line 107 of file singleton.hpp.

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

Test whether i is not in the least upper bound.

Definition at line 111 of file singleton.hpp.

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

Restrict cardinality to be greater than or equal to m.

Definition at line 134 of file singleton.hpp.

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

Restrict cardinality to be less than or equal to m.

Definition at line 139 of file singleton.hpp.

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 177 of file singleton.hpp.

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 182 of file singleton.hpp.

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

Update greatest lower bound to contain i.

Definition at line 144 of file singleton.hpp.

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

Restrict least upper bound to not contain i.

Definition at line 172 of file singleton.hpp.

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 154 of file singleton.hpp.

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

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

Definition at line 149 of file singleton.hpp.

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 200 of file singleton.hpp.

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 205 of file singleton.hpp.

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 221 of file singleton.hpp.

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

Schedule propagator p with modification event me.

Reimplemented from Gecode::DerivedView< Gecode::Int::IntView >.

Definition at line 250 of file singleton.hpp.

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

Return modification event for view type in med.

Reimplemented from Gecode::DerivedView< Gecode::Int::IntView >.

Definition at line 254 of file singleton.hpp.

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

Translate modification event me to modification event delta for view.

Reimplemented from Gecode::DerivedView< Gecode::Int::IntView >.

Definition at line 258 of file singleton.hpp.

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

Subscribe propagator p with propagation condition pc to view.

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

Reimplemented from Gecode::DerivedView< Gecode::Int::IntView >.

Definition at line 226 of file singleton.hpp.

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

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

Reimplemented from Gecode::DerivedView< Gecode::Int::IntView >.

Definition at line 231 of file singleton.hpp.

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

Re-schedule propagator p with propagation condition pc.

Reimplemented from Gecode::DerivedView< Gecode::Int::IntView >.

Definition at line 235 of file singleton.hpp.

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

Subscribe advisor a to view.

Definition at line 240 of file singleton.hpp.

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

Cancel subscription of advisor a.

Definition at line 244 of file singleton.hpp.

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

Return modification event.

Reimplemented from Gecode::DerivedView< Gecode::Int::IntView >.

Definition at line 272 of file singleton.hpp.

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

Return minimum value just pruned from glb.

Definition at line 277 of file singleton.hpp.

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

Return maximum value just pruned from glb.

Definition at line 280 of file singleton.hpp.

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

Test whether arbitrary values got pruned from glb.

Definition at line 283 of file singleton.hpp.

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

Return minimum value just pruned from lub.

Definition at line 286 of file singleton.hpp.

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

Return maximum value just pruned from lub.

Definition at line 289 of file singleton.hpp.

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

Test whether arbitrary values got pruned from lub.

Definition at line 292 of file singleton.hpp.


Friends And Related Function Documentation

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

Print singleton set view.

Definition at line 120 of file print.hpp.

bool operator== ( const SingletonView x,
const SingletonView y 
) [related]

Test whether views x and y are the same.

Definition at line 295 of file singleton.hpp.

bool operator!= ( const SingletonView x,
const SingletonView y 
) [related]

Test whether views x and y are the not same.

Definition at line 300 of file singleton.hpp.


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