Gecode::Set::ComplementView< View > Class Template Reference
Functionality by programming task » Programming actors » Programming set actors » Set views

Complement set view. More...

`#include <view.hpp>`

## 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.
static bool | varderived (void)
| Return whether this view is derived from a VarImpView.
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.
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.

## 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 &y)
| Initialize with set view 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 | subscribe (Space &home, Advisor &a)
| Subscribe advisor a to view.
void | cancel (Space &home, Advisor &a)
| Cancel subscription of advisor a.

## View comparison

template<class Char, class Traits, class View>
std::basic_ostream< Char, Traits > & | operator<< (std::basic_ostream< Char, Traits > &os, const ComplementView< View > &x)
| Print complement set view.
template<class View>
bool | operator== (const ComplementView< View > &x, const ComplementView< View > &y)
| Test whether views x and y are the same.
template<class View>
bool | operator!= (const ComplementView< View > &x, const ComplementView< View > &y)
| Test whether views x and y are the not same.

## Additional Inherited Members

Public Types inherited from Gecode::DerivedView< View >
typedef View::VarImpType | VarImpType
| The variable implementation type belonging to the View.
typedef View::VarType | VarType
| The variable type belonging to the View.
Public Member Functions inherited from Gecode::DerivedView< View >
| DerivedView (const View &y)
| Initialize with view y.
VarImpType * | varimp (void) const
| Return variable implementation of view.
View | base (void) const
| Return view from which this view is derived.
unsigned int | degree (void) const
| Return degree (number of subscribed propagators).
double | afc (void) const
| Return accumulated failure count.
bool | assigned (void) const
| Test whether view is assigned.
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, bool fail=false)
| Subscribe advisor a to view.
void | cancel (Space &home, Advisor &a, bool fail=false)
| Cancel subscription of advisor a.
void | update (Space &home, DerivedView< View > &y)
| Update this view to be a clone of view y.
bool | operator< (const DerivedView< View > &y) const
| Whether this view comes before view y (arbitray order).
Protected Member Functions inherited from Gecode::DerivedView< View >
| DerivedView (void)
| Default constructor.
Protected Attributes inherited from Gecode::DerivedView< View >
View | x
| View from which this view is derived.

## Detailed Description

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

Complement set view.

A complement set view for a set view provides operations such that behaves like the complement of . The complement is defined in terms of the set universe.

Definition at line 769 of file view.hpp.

## Constructor & Destructor Documentation

## ComplementView() [1/2]

template<class View>

Gecode::Set::ComplementView< View >::ComplementView | ( | void |  | ) |

inline

Default constructor.

Definition at line 44 of file complement.hpp.

## ComplementView() [2/2]

template<class View>

Gecode::Set::ComplementView< View >::ComplementView | ( | View & | y | ) |

inline explicit

Initialize with set view y.

Definition at line 48 of file complement.hpp.

## Member Function Documentation

## pc_negateset()

template<class View>

PropCond Gecode::Set::ComplementView< View >::pc_negateset | ( | PropCond | pc | ) |

inline static

Negate the propagation condition pc.

Definition at line 65 of file complement.hpp.

## me_negateset()

template<class View>

ModEvent Gecode::Set::ComplementView< View >::me_negateset | ( | ModEvent | me | ) |

inline static

Negate the modification event me.

Definition at line 53 of file complement.hpp.

## cardMin() [1/2]

template<class View>

unsigned int Gecode::Set::ComplementView< View >::cardMin | ( | void |  | ) | const

inline

Return minimum cardinality.

Definition at line 101 of file complement.hpp.

## cardMax() [1/2]

template<class View>

unsigned int Gecode::Set::ComplementView< View >::cardMax | ( | void |  | ) | const

inline

Return maximum cardinality.

Definition at line 107 of file complement.hpp.

## lubMin() [1/2]

template<class View>

int Gecode::Set::ComplementView< View >::lubMin | ( | void |  | ) | const

inline

Return minimum of the least upper bound.

Definition at line 113 of file complement.hpp.

## lubMax() [1/2]

template<class View>

int Gecode::Set::ComplementView< View >::lubMax | ( | void |  | ) | const

inline

Return maximum of the least upper bound.

Definition at line 125 of file complement.hpp.

## lubMinN()

template<class View>

int Gecode::Set::ComplementView< View >::lubMinN | ( | unsigned int | n | ) | const

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

## glbMin() [1/2]

template<class View>

int Gecode::Set::ComplementView< View >::glbMin | ( | void |  | ) | const

inline

Return minimum of the greatest lower bound.

Definition at line 138 of file complement.hpp.

## glbMax() [1/2]

template<class View>

int Gecode::Set::ComplementView< View >::glbMax | ( | void |  | ) | const

inline

Return maximum of the greatest lower bound.

Definition at line 150 of file complement.hpp.

## glbSize()

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 75 of file complement.hpp.

## lubSize()

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 81 of file complement.hpp.

## unknownSize()

template<class View>

unsigned int Gecode::Set::ComplementView< View >::unknownSize | ( | void |  | ) | const

inline

Return the number of unknown elements.

Definition at line 87 of file complement.hpp.

## contains()

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 93 of file complement.hpp.

## notContains()

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 97 of file complement.hpp.

## cardMin() [2/2]

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 163 of file complement.hpp.

## cardMax() [2/2]

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 171 of file complement.hpp.

## include() [1/2]

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 207 of file complement.hpp.

## exclude() [1/2]

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 213 of file complement.hpp.

## include() [2/2]

template<class View>

ModEvent Gecode::Set::ComplementView< View >::include | ( | Space & | home,
|  | int | i )

inline

Update greatest lower bound to contain i.

Definition at line 179 of file complement.hpp.

## exclude() [2/2]

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 185 of file complement.hpp.

## intersect() [1/2]

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 199 of file complement.hpp.

## intersect() [2/2]

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 191 of file complement.hpp.

## excludeI()

template<class View>
template<class I>

ModEvent Gecode::Set::ComplementView< View >::excludeI | ( | Space & | home,
|  | I & | i )

Remove range sequence described by i from least upper bound.

Definition at line 219 of file complement.hpp.

## includeI()

template<class View>
template<class I>

ModEvent Gecode::Set::ComplementView< View >::includeI | ( | Space & | home,
|  | I & | i )

Include range sequence described by i in greatest lower bound.

Definition at line 225 of file complement.hpp.

## intersectI()

template<class View>
template<class I>

ModEvent Gecode::Set::ComplementView< View >::intersectI | ( | Space & | home,
|  | I & | iter )

Intersect least upper bound with range sequence described by i.

Definition at line 231 of file complement.hpp.

## schedule()

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 263 of file complement.hpp.

## me()

template<class View>

ModEvent Gecode::Set::ComplementView< View >::me | ( | const ModEventDelta & | med | ) |

inline static

Return modification event for view type in med.

Definition at line 268 of file complement.hpp.

## med()

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 274 of file complement.hpp.

## subscribe() [1/2]

template<class View>

void Gecode::Set::ComplementView< View >::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).

Definition at line 238 of file complement.hpp.

## cancel() [1/2]

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 245 of file complement.hpp.

## subscribe() [2/2]

template<class View>

void Gecode::Set::ComplementView< View >::subscribe | ( | Space & | home,
|  | Advisor & | a )

inline

Subscribe advisor a to view.

Definition at line 251 of file complement.hpp.

## cancel() [2/2]

template<class View>

void Gecode::Set::ComplementView< View >::cancel | ( | Space & | home,
|  | Advisor & | a )

inline

Cancel subscription of advisor a.

Definition at line 257 of file complement.hpp.

## modevent()

template<class View>

ModEvent Gecode::Set::ComplementView< View >::modevent | ( | const Delta & | d | ) |

inline static

Return modification event.

Definition at line 285 of file complement.hpp.

## glbMin() [2/2]

template<class View>

int Gecode::Set::ComplementView< View >::glbMin | ( | const Delta & | d | ) | const

inline

Return minimum value just pruned from glb.

Definition at line 291 of file complement.hpp.

## glbMax() [2/2]

template<class View>

int Gecode::Set::ComplementView< View >::glbMax | ( | const Delta & | d | ) | const

inline

Return maximum value just pruned from glb.

Definition at line 297 of file complement.hpp.

## glbAny()

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 303 of file complement.hpp.

## lubMin() [2/2]

template<class View>

int Gecode::Set::ComplementView< View >::lubMin | ( | const Delta & | d | ) | const

inline

Return minimum value just pruned from lub.

Definition at line 309 of file complement.hpp.

## lubMax() [2/2]

template<class View>

int Gecode::Set::ComplementView< View >::lubMax | ( | const Delta & | d | ) | const

inline

Return maximum value just pruned from lub.

Definition at line 315 of file complement.hpp.

## lubAny()

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 321 of file complement.hpp.

## Friends And Related Symbol Documentation

## operator<<()

template<class Char, class Traits, class View>

std::basic_ostream< Char, Traits > & operator<< | ( | std::basic_ostream< Char, Traits > & | os,
|  | const ComplementView< View > & | x )

related

Print complement set view.

Definition at line 535 of file complement.hpp.

## operator==()

template<class View>

bool operator== | ( | const ComplementView< View > & | x,
|  | const ComplementView< View > & | y )

related

Test whether views x and y are the same.

Definition at line 553 of file complement.hpp.

## operator!=()

template<class View>

bool operator!= | ( | const ComplementView< View > & | x,
|  | const ComplementView< View > & | y )

related

Test whether views x and y are the not same.

Definition at line 559 of file complement.hpp.

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

- gecode/set/view.hpp
- gecode/set/view/complement.hpp