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

Gecode::Set::ComplementView< View > Class Template Reference
[Set views]

Inherits Gecode::DerivedViewBase< View >.

List of all members.


Detailed Description

template<class View>
class Gecode::Set::ComplementView< View >

Complement set view.

A complement set view $s$ for a set view $t$ provides operations such that $s$ behaves like the complement of $\{t\}$. The complement is defined in terms of the set universe.

Definition at line 1000 of file view.icc.


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.

Reflection

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

Delta information for advisors

static ModEvent modevent (const Delta *d)
 Return modification event.
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.

Constructors and initialization

 ComplementView (void)
 Default constructor.
 ComplementView (View &x)
 Initialize with set view x.
 ComplementView (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, ComplementView &x)
 Update this view to be a clone of view x.

View comparison

template<class View>
bool same (const Set::ComplementView< View > &x, const Set::ComplementView< View > &y)
 Test whether views x and y are the same.
template<class View>
bool before (const Set::ComplementView< View > &x, const Set::ComplementView< View > &y)
 Test whether view x comes before y (arbitrary order).

View comparison

template<class View>
bool same (const Set::OffsetSetView< View > &x, const Set::OffsetSetView< View > &y)
 Test whether views x and y are the same.
template<class View>
bool before (const Set::OffsetSetView< View > &x, const Set::OffsetSetView< View > &y)
 Test whether view x comes before y (arbitrary order).

Static Public Member Functions

static PropCond pc_negateset (PropCond pc)
 Negate the propagation condition pc.
static ModEvent me_negateset (ModEvent me)
 Negate the modification event me.

Related Functions

(Note that these are not member functions.)

template<class View>
std::ostream & operator<< (std::ostream &, const Gecode::Set::ComplementView< View > &)
 Print set complement view.

Constructor & Destructor Documentation

template<class View>
Gecode::Set::ComplementView< View >::ComplementView ( void   )  [inline]

Default constructor.

Definition at line 46 of file complement.icc.

template<class View>
Gecode::Set::ComplementView< View >::ComplementView ( View &  x  )  [inline]

Initialize with set view x.

Definition at line 50 of file complement.icc.

template<class View>
Gecode::Set::ComplementView< View >::ComplementView ( Space home,
const Reflection::VarMap vars,
Reflection::Arg arg 
) [inline]

Initialize from specification.

Definition at line 55 of file complement.icc.


Member Function Documentation

template<class View>
PropCond Gecode::Set::ComplementView< View >::pc_negateset ( PropCond  pc  )  [inline, static]

Negate the propagation condition pc.

Definition at line 74 of file complement.icc.

template<class View>
ModEvent Gecode::Set::ComplementView< View >::me_negateset ( ModEvent  me  )  [inline, static]

Negate the modification event me.

Definition at line 62 of file complement.icc.

template<class View>
unsigned int Gecode::Set::ComplementView< View >::cardMin ( void   )  const [inline]

Return minimum cardinality.

Definition at line 114 of file complement.icc.

template<class View>
unsigned int Gecode::Set::ComplementView< View >::cardMax ( void   )  const [inline]

Return maximum cardinality.

Definition at line 120 of file complement.icc.

template<class View>
int Gecode::Set::ComplementView< View >::lubMin ( void   )  const [inline]

Return minimum of the least upper bound.

Definition at line 126 of file complement.icc.

template<class View>
int Gecode::Set::ComplementView< View >::lubMax ( void   )  const [inline]

Return maximum of the least upper bound.

Definition at line 138 of file complement.icc.

template<class View>
int Gecode::Set::ComplementView< View >::lubMinN ( int  n  )  const

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

template<class View>
int Gecode::Set::ComplementView< View >::glbMin ( void   )  const [inline]

Return minimum of the greatest lower bound.

Definition at line 151 of file complement.icc.

template<class View>
int Gecode::Set::ComplementView< View >::glbMax ( void   )  const [inline]

Return maximum of the greatest lower bound.

Definition at line 163 of file complement.icc.

template<class View>
unsigned int Gecode::Set::ComplementView< View >::glbSize ( void   )  const [inline]

Return the number of elements in the greatest lower bound.

Definition at line 88 of file complement.icc.

template<class View>
unsigned int Gecode::Set::ComplementView< View >::lubSize ( void   )  const [inline]

Return the number of elements in the least upper bound.

Definition at line 94 of file complement.icc.

template<class View>
unsigned int Gecode::Set::ComplementView< View >::unknownSize ( void   )  const [inline]

Return the number of unknown elements.

Definition at line 100 of file complement.icc.

template<class View>
bool Gecode::Set::ComplementView< View >::assigned ( void   )  const [inline]

Test whether view is assigned.

Definition at line 84 of file complement.icc.

template<class View>
bool Gecode::Set::ComplementView< View >::contains ( int  i  )  const [inline]

Test whether i is in the greatest lower bound.

Definition at line 106 of file complement.icc.

template<class View>
bool Gecode::Set::ComplementView< View >::notContains ( int  i  )  const [inline]

Test whether i is not in the least upper bound.

Definition at line 110 of file complement.icc.

template<class View>
ModEvent Gecode::Set::ComplementView< View >::cardMin ( Space home,
unsigned int  m 
) [inline]

Restrict cardinality to be greater than or equal to m.

Definition at line 176 of file complement.icc.

template<class View>
ModEvent Gecode::Set::ComplementView< View >::cardMax ( Space home,
unsigned int  m 
) [inline]

Restrict cardinality to be less than or equal to m.

Definition at line 184 of file complement.icc.

template<class View>
ModEvent Gecode::Set::ComplementView< View >::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 220 of file complement.icc.

template<class View>
ModEvent Gecode::Set::ComplementView< View >::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 226 of file complement.icc.

template<class View>
ModEvent Gecode::Set::ComplementView< View >::include ( Space home,
int  i 
) [inline]

Update greatest lower bound to contain i.

Definition at line 192 of file complement.icc.

template<class View>
ModEvent Gecode::Set::ComplementView< View >::exclude ( Space home,
int  i 
) [inline]

Restrict least upper bound to not contain i.

Definition at line 198 of file complement.icc.

template<class View>
ModEvent Gecode::Set::ComplementView< View >::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 212 of file complement.icc.

template<class View>
ModEvent Gecode::Set::ComplementView< View >::intersect ( Space home,
int  i 
) [inline]

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

Definition at line 204 of file complement.icc.

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

Remove range sequence described by i from least upper bound.

Definition at line 232 of file complement.icc.

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

Include range sequence described by i in greatest lower bound.

Definition at line 238 of file complement.icc.

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

Intersect least upper bound with range sequence described by i.

Definition at line 244 of file complement.icc.

template<class View>
void Gecode::Set::ComplementView< View >::schedule ( Space home,
Propagator p,
ModEvent  me 
) [inline, static]

Schedule propagator p with modification event me.

Definition at line 276 of file complement.icc.

template<class View>
ModEvent Gecode::Set::ComplementView< View >::me ( ModEventDelta  med  )  [inline, static]

Return modification event for view type in med.

Definition at line 281 of file complement.icc.

template<class View>
ModEventDelta Gecode::Set::ComplementView< View >::med ( ModEvent  me  )  [inline, static]

Translate modification event me to modification event delta for view.

Definition at line 287 of file complement.icc.

template<class View>
void Gecode::Set::ComplementView< View >::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 251 of file complement.icc.

template<class View>
void Gecode::Set::ComplementView< View >::cancel ( Space home,
Propagator p,
PropCond  pc 
) [inline]

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

Definition at line 258 of file complement.icc.

template<class View>
void Gecode::Set::ComplementView< View >::subscribe ( Space home,
Advisor a 
) [inline]

Subscribe advisor a to view.

Definition at line 264 of file complement.icc.

template<class View>
void Gecode::Set::ComplementView< View >::cancel ( Space home,
Advisor a 
) [inline]

Cancel subscription of advisor a.

Definition at line 270 of file complement.icc.

template<class View>
void Gecode::Set::ComplementView< View >::update ( Space home,
bool  share,
ComplementView< View > &  x 
) [inline]

Update this view to be a clone of view x.

Definition at line 293 of file complement.icc.

template<class View>
Reflection::Arg * Gecode::Set::ComplementView< View >::spec ( const Space home,
Reflection::VarMap m 
) const [inline]

Return specification for this view, using variable map m.

Definition at line 300 of file complement.icc.

template<class View>
Support::Symbol Gecode::Set::ComplementView< View >::type ( void   )  [inline, static]

Return specification for this view, using variable map m.

Definition at line 306 of file complement.icc.

template<class View>
ModEvent Gecode::Set::ComplementView< View >::modevent ( const Delta d  )  [inline, static]

Return modification event.

Definition at line 320 of file complement.icc.

template<class View>
int Gecode::Set::ComplementView< View >::glbMin ( const Delta d  )  const [inline]

Return minimum value just pruned from glb.

Definition at line 326 of file complement.icc.

template<class View>
int Gecode::Set::ComplementView< View >::glbMax ( const Delta d  )  const [inline]

Return maximum value just pruned from glb.

Definition at line 332 of file complement.icc.

template<class View>
bool Gecode::Set::ComplementView< View >::glbAny ( const Delta d  )  const [inline]

Test whether arbitrary values got pruned from glb.

Definition at line 338 of file complement.icc.

template<class View>
int Gecode::Set::ComplementView< View >::lubMin ( const Delta d  )  const [inline]

Return minimum value just pruned from lub.

Definition at line 344 of file complement.icc.

template<class View>
int Gecode::Set::ComplementView< View >::lubMax ( const Delta d  )  const [inline]

Return maximum value just pruned from lub.

Definition at line 350 of file complement.icc.

template<class View>
bool Gecode::Set::ComplementView< View >::lubAny ( const Delta d  )  const [inline]

Test whether arbitrary values got pruned from lub.

Definition at line 356 of file complement.icc.


Friends And Related Function Documentation

template<class View>
bool same ( const Set::ComplementView< View > &  x,
const Set::ComplementView< View > &  y 
) [related]

Test whether views x and y are the same.

Definition at line 582 of file complement.icc.

template<class View>
bool before ( const Set::ComplementView< View > &  x,
const Set::ComplementView< View > &  y 
) [related]

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

Definition at line 588 of file complement.icc.

template<class View>
bool same ( const Set::OffsetSetView< View > &  x,
const Set::OffsetSetView< View > &  y 
) [related]

Test whether views x and y are the same.

Definition at line 477 of file offset.icc.

template<class View>
bool before ( const Set::OffsetSetView< View > &  x,
const Set::OffsetSetView< View > &  y 
) [related]

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

Definition at line 483 of file offset.icc.

template<class View>
std::ostream & operator<< ( std::ostream &  ,
const Gecode::Set::ComplementView< View > &   
) [related]

Print set complement view.

Definition at line 610 of file complement.icc.


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