Generated on Mon May 10 06:47:01 2010 for Gecode by doxygen 1.6.3

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

Constant view for the universe. More...

#include <view.hpp>

List of all members.

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 UniverseView &x)
 Print universe set view.

Constructors and initialization



 UniverseView (void)
 Default constructor.

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 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, UniverseView &x)
 Update this view to be a clone of view x.

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 same (const Set::UniverseView &x, const Set::UniverseView &y)
 Test whether views x and y are the same.
bool before (const Set::UniverseView &x, const Set::UniverseView &y)
 Test whether view x comes before y (arbitrary order).

Detailed Description

Constant view for the universe.

A constant set view $x$ for the universe provides operations such that $x$ behaves like the universe.

Definition at line 604 of file view.hpp.


Constructor & Destructor Documentation

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

Default constructor.

Definition at line 499 of file const.hpp.


Member Function Documentation

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

Return minimum cardinality.

Definition at line 520 of file const.hpp.

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

Return maximum cardinality.

Definition at line 523 of file const.hpp.

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

Return minimum of the least upper bound.

Definition at line 526 of file const.hpp.

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

Return maximum of the least upper bound.

Definition at line 529 of file const.hpp.

int Gecode::Set::UniverseView::lubMinN ( unsigned int  n  )  const

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

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

Return minimum of the greatest lower bound.

Definition at line 532 of file const.hpp.

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

Return maximum of the greatest lower bound.

Definition at line 535 of file const.hpp.

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

Return the number of elements in the greatest lower bound.

Definition at line 505 of file const.hpp.

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

Return the number of elements in the least upper bound.

Definition at line 508 of file const.hpp.

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

Return the number of unknown elements.

Definition at line 511 of file const.hpp.

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

Test whether view is assigned.

Definition at line 502 of file const.hpp.

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

Test whether i is in the greatest lower bound.

Definition at line 514 of file const.hpp.

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

Test whether i is not in the least upper bound.

Definition at line 517 of file const.hpp.

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

Restrict cardinality to be greater than or equal to m.

Definition at line 538 of file const.hpp.

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

Restrict cardinality to be less than or equal to m.

Definition at line 543 of file const.hpp.

ModEvent Gecode::Set::UniverseView::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 560 of file const.hpp.

ModEvent Gecode::Set::UniverseView::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 563 of file const.hpp.

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

Update greatest lower bound to contain i.

Definition at line 549 of file const.hpp.

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

Restrict least upper bound to not contain i.

Definition at line 554 of file const.hpp.

ModEvent Gecode::Set::UniverseView::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 578 of file const.hpp.

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

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

Definition at line 557 of file const.hpp.

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

Remove range sequence described by i from least upper bound.

Definition at line 566 of file const.hpp.

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

Include range sequence described by i in greatest lower bound.

Definition at line 572 of file const.hpp.

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

Intersect least upper bound with range sequence described by i.

Definition at line 584 of file const.hpp.

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

Schedule propagator p with modification event me.

Definition at line 593 of file const.hpp.

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

Return modification event for view type in med.

Definition at line 597 of file const.hpp.

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

Translate modification event me to modification event delta for view.

Definition at line 601 of file const.hpp.

void Gecode::Set::UniverseView::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 605 of file const.hpp.

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

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

Definition at line 611 of file const.hpp.

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

Subscribe advisor a to view.

Definition at line 614 of file const.hpp.

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

Cancel subscription of advisor a.

Definition at line 616 of file const.hpp.

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

Update this view to be a clone of view x.

Definition at line 620 of file const.hpp.

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

Return modification event.

Definition at line 629 of file const.hpp.

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

Return minimum value just pruned from glb.

Definition at line 635 of file const.hpp.

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

Return maximum value just pruned from glb.

Definition at line 641 of file const.hpp.

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

Test whether arbitrary values got pruned from glb.

Definition at line 647 of file const.hpp.

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

Return minimum value just pruned from lub.

Definition at line 653 of file const.hpp.

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

Return maximum value just pruned from lub.

Definition at line 659 of file const.hpp.

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

Test whether arbitrary values got pruned from lub.

Definition at line 665 of file const.hpp.


Friends And Related Function Documentation

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

Print universe set view.

Definition at line 104 of file print.hpp.

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

Test whether views x and y are the same.

Definition at line 860 of file const.hpp.

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

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

Definition at line 864 of file const.hpp.


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