Generated on Wed Nov 1 15:05:23 2006 for Gecode by doxygen 1.4.5
Gecode::Set::UniverseView

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

Inherits Gecode::ConstantViewBase.

List of all members.

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 488 of file view.icc.

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 (int n) const
 Return n-th smallest element of the least upper bound.
int lubMaxN (int n) const
 Return the n-th largest 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 variable.
void cancel (Space *home, Propagator *p, PropCond pc)
 Cancel subscription of propagator p with propagation condition pc to view.

Cloning

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

Propagator modification events

static ModEvent pme (const Propagator *p)
 Return modification event of propagator p for view.
static PropModEvent pme (ModEvent)
 Translate modification event me to propagator modification event 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).

Related Functions

(Note that these are not member functions.)

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

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 346 of file const.icc.

Member Function Documentation

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

Return minimum cardinality.

Definition at line 367 of file const.icc.

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

Return maximum cardinality.

Definition at line 370 of file const.icc.

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

Return minimum of the least upper bound.

Definition at line 373 of file const.icc.

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

Return maximum of the least upper bound.

Definition at line 376 of file const.icc.

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

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

int Gecode::Set::UniverseView::lubMaxN (  int  n  )  const
 

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

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

Return minimum of the greatest lower bound.

Definition at line 379 of file const.icc.

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

Return maximum of the greatest lower bound.

Definition at line 382 of file const.icc.

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

Return the number of elements in the greatest lower bound.

Definition at line 352 of file const.icc.

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

Return the number of elements in the least upper bound.

Definition at line 355 of file const.icc.

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

Return the number of unknown elements.

Definition at line 358 of file const.icc.

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

Test whether view is assigned.

Definition at line 349 of file const.icc.

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

Test whether i is in the greatest lower bound.

Definition at line 361 of file const.icc.

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

Test whether i is not in the least upper bound.

Definition at line 364 of file const.icc.

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

Restrict cardinality to be greater than or equal to m.

Definition at line 385 of file const.icc.

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

Restrict cardinality to be less than or equal to m.

Definition at line 390 of file const.icc.

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 407 of file const.icc.

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 410 of file const.icc.

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

Update greatest lower bound to contain i.

Definition at line 396 of file const.icc.

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

Restrict least upper bound to not contain i.

Definition at line 401 of file const.icc.

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 421 of file const.icc.

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

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

Definition at line 404 of file const.icc.

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

Remove range sequence described by i from least upper bound.

Definition at line 413 of file const.icc.

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 418 of file const.icc.

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 427 of file const.icc.

ModEvent Gecode::Set::UniverseView::pme (  const Propagator *  p  )  [inline, static]
 

Return modification event of propagator p for view.

Definition at line 440 of file const.icc.

PropModEvent Gecode::Set::UniverseView::pme (  ModEvent   )  [inline, static]
 

Translate modification event me to propagator modification event for view.

Definition at line 444 of file const.icc.

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

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 437 of file const.icc.

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 449 of file const.icc.

Friends And Related Function Documentation

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

Test whether views x and y are the same.

Definition at line 640 of file const.icc.

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

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

Definition at line 644 of file const.icc.

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

Print universe set view.

Definition at line 103 of file print.cc.

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