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

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

Inherits Gecode::ConstantViewBase.

List of all members.

Detailed Description

Constant view for the empty set.

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

Definition at line 336 of file view.icc.

Constructors and initialization

 EmptyView (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, EmptyView &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::EmptyView &x, const Set::EmptyView &y)
 Test whether views x and y are the same.
bool before (const Set::EmptyView &x, const Set::EmptyView &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::EmptyView &)
 Print empty set view.

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 240 of file const.icc.

Member Function Documentation

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

Return minimum cardinality.

Definition at line 262 of file const.icc.

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

Return maximum cardinality.

Definition at line 265 of file const.icc.

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

Return minimum of the least upper bound.

Definition at line 268 of file const.icc.

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

Return maximum of the least upper bound.

Definition at line 271 of file const.icc.

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

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

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

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

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

Return minimum of the greatest lower bound.

Definition at line 274 of file const.icc.

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

Return maximum of the greatest lower bound.

Definition at line 277 of file const.icc.

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

Return the number of elements in the greatest lower bound.

Definition at line 247 of file const.icc.

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

Return the number of elements in the least upper bound.

Definition at line 250 of file const.icc.

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

Return the number of unknown elements.

Definition at line 253 of file const.icc.

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

Test whether view is assigned.

Definition at line 244 of file const.icc.

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

Test whether i is in the greatest lower bound.

Definition at line 256 of file const.icc.

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

Test whether i is not in the least upper bound.

Definition at line 259 of file const.icc.

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

Restrict cardinality to be greater than or equal to m.

Definition at line 280 of file const.icc.

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

Restrict cardinality to be less than or equal to m.

Definition at line 285 of file const.icc.

ModEvent Gecode::Set::EmptyView::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 305 of file const.icc.

ModEvent Gecode::Set::EmptyView::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 309 of file const.icc.

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

Update greatest lower bound to contain i.

Definition at line 291 of file const.icc.

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

Restrict least upper bound to not contain i.

Definition at line 296 of file const.icc.

ModEvent Gecode::Set::EmptyView::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 302 of file const.icc.

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

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

Definition at line 299 of file const.icc.

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

Remove range sequence described by i from least upper bound.

Definition at line 312 of file const.icc.

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

Include range sequence described by i in greatest lower bound.

Definition at line 315 of file const.icc.

template<class I>
ModEvent Gecode::Set::EmptyView::intersectI (  Space *  home,
I &  iter
) 
 

Intersect least upper bound with range sequence described by i.

Definition at line 320 of file const.icc.

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

Return modification event of propagator p for view.

Definition at line 330 of file const.icc.

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

Translate modification event me to propagator modification event for view.

Definition at line 334 of file const.icc.

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

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

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

Definition at line 327 of file const.icc.

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

Update this view to be a clone of view x.

Definition at line 339 of file const.icc.

Friends And Related Function Documentation

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

Test whether views x and y are the same.

Definition at line 631 of file const.icc.

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

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

Definition at line 635 of file const.icc.

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

Print empty set view.

Definition at line 98 of file print.cc.

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