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

Cached set view. More...

`#include <view.hpp>`

## Public Member Functions

template<class I>
ModEvent | excludeI (Space &home, I &iter)
template<class I>
ModEvent | includeI (Space &home, I &iter)
template<class I>
ModEvent | intersectI (Space &home, I &iter)
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 Attributes

LUBndSet | lubCache
| The cached least upper bound.
GLBndSet | glbCache
| The cached greatest lower bound.
Protected Attributes inherited from Gecode::DerivedView< View >
View | x
| View from which this view is derived.

## Constructors and initialization

| CachedView (void)
| Default constructor.
| CachedView (const 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.

## 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.

## Domain cache operations

void | initCache (Space &home, const IntSet &glb, const IntSet &lub)
| Initialize cache to bounds glb and lub.
void | cacheGlb (Space &home)
| Update greatest lower bound cache to current domain.
void | cacheLub (Space &home)
| Update least upper bound cache to current domain.
bool | glbModified (void) const
| Check whether greatest lower bound cache differs from current domain.
bool | lubModified (void) const
| Check whether least upper bound cache differs from current domain.

## Cloning

void | update (Space &home, CachedView< View > &y)
| Update this view to be a clone of view y.

## 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

template<class Char, class Traits, class View>
std::basic_ostream< Char, Traits > & | operator<< (std::basic_ostream< Char, Traits > &os, const CachedView< View > &x)
| Print cached set view.
template<class View>
bool | operator== (const CachedView< View > &x, const CachedView< View > &y)
| Test whether views x and y are the same.
template<class View>
bool | operator!= (const CachedView< View > &x, const CachedView< 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.
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.
Protected Member Functions inherited from Gecode::DerivedView< View >
| DerivedView (void)
| Default constructor.

## Detailed Description

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

Cached set view.

A cached set view for a set view adds operations for cacheing the current domain of and comparing the current domain to the cached domain. Cached views make it easy to implement incremental propagation algorithms.

Definition at line 948 of file view.hpp.

## Constructor & Destructor Documentation

## CachedView() [1/2]

template<class View>

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

Default constructor.

## CachedView() [2/2]

template<class View>

Gecode::Set::CachedView< View >::CachedView | ( | const View & | y | ) |

explicit

Initialize with set view y.

## Member Function Documentation

## cardMin() [1/2]

template<class View>

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

inline

Return minimum cardinality.

Definition at line 75 of file cached.hpp.

## cardMax() [1/2]

template<class View>

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

inline

Return maximum cardinality.

Definition at line 81 of file cached.hpp.

## lubMin() [1/2]

template<class View>

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

inline

Return minimum of the least upper bound.

Definition at line 87 of file cached.hpp.

## lubMax() [1/2]

template<class View>

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

inline

Return maximum of the least upper bound.

Definition at line 93 of file cached.hpp.

## lubMinN()

template<class View>

int Gecode::Set::CachedView< 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::CachedView< View >::glbMin | ( | void |  | ) | const

inline

Return minimum of the greatest lower bound.

Definition at line 99 of file cached.hpp.

## glbMax() [1/2]

template<class View>

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

inline

Return maximum of the greatest lower bound.

Definition at line 105 of file cached.hpp.

## glbSize()

template<class View>

unsigned int Gecode::Set::CachedView< View >::glbSize | ( | void |  | ) | const

inline

Return the number of elements in the greatest lower bound.

Definition at line 49 of file cached.hpp.

## lubSize()

template<class View>

unsigned int Gecode::Set::CachedView< View >::lubSize | ( | void |  | ) | const

inline

Return the number of elements in the least upper bound.

Definition at line 55 of file cached.hpp.

## unknownSize()

template<class View>

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

inline

Return the number of unknown elements.

Definition at line 61 of file cached.hpp.

## contains()

template<class View>

bool Gecode::Set::CachedView< View >::contains | ( | int | i | ) | const

inline

Test whether i is in the greatest lower bound.

Definition at line 67 of file cached.hpp.

## notContains()

template<class View>

bool Gecode::Set::CachedView< View >::notContains | ( | int | i | ) | const

inline

Test whether i is not in the least upper bound.

Definition at line 71 of file cached.hpp.

## cardMin() [2/2]

template<class View>

ModEvent Gecode::Set::CachedView< View >::cardMin | ( | Space & | home,
|  | unsigned int | m )

inline

Restrict cardinality to be greater than or equal to m.

Definition at line 111 of file cached.hpp.

## cardMax() [2/2]

template<class View>

ModEvent Gecode::Set::CachedView< View >::cardMax | ( | Space & | home,
|  | unsigned int | m )

inline

Restrict cardinality to be less than or equal to m.

Definition at line 117 of file cached.hpp.

## include() [1/2]

template<class View>

ModEvent Gecode::Set::CachedView< 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 147 of file cached.hpp.

## exclude() [1/2]

template<class View>

ModEvent Gecode::Set::CachedView< 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 153 of file cached.hpp.

## include() [2/2]

template<class View>

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

inline

Update greatest lower bound to contain i.

Definition at line 123 of file cached.hpp.

## exclude() [2/2]

template<class View>

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

inline

Restrict least upper bound to not contain i.

Definition at line 129 of file cached.hpp.

## intersect() [1/2]

template<class View>

ModEvent Gecode::Set::CachedView< 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 141 of file cached.hpp.

## intersect() [2/2]

template<class View>

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

inline

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

Definition at line 135 of file cached.hpp.

## excludeI() [1/2]

template<class View>
template<class I>

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

Remove range sequence described by i from least upper bound.

## includeI() [1/2]

template<class View>
template<class I>

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

Include range sequence described by i in greatest lower bound.

## intersectI() [1/2]

template<class View>
template<class I>

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

Intersect least upper bound with range sequence described by i.

## schedule()

template<class View>

void Gecode::Set::CachedView< View >::schedule | ( | Space & | home,
|  | Propagator & | p,
|  | ModEvent | me )

inline static

Schedule propagator p with modification event me.

Definition at line 202 of file cached.hpp.

## me()

template<class View>

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

inline static

Return modification event for view type in med.

Definition at line 207 of file cached.hpp.

## med()

template<class View>

ModEventDelta Gecode::Set::CachedView< View >::med | ( | ModEvent |  | ) |

static

Translate modification event me to modification event delta for view.

## subscribe() [1/2]

template<class View>

void Gecode::Set::CachedView< 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 177 of file cached.hpp.

## cancel() [1/2]

template<class View>

void Gecode::Set::CachedView< View >::cancel | ( | Space & | home,
|  | Propagator & | p,
|  | PropCond | pc )

inline

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

Definition at line 184 of file cached.hpp.

## subscribe() [2/2]

template<class View>

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

inline

Subscribe advisor a to view.

Definition at line 190 of file cached.hpp.

## cancel() [2/2]

template<class View>

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

inline

Cancel subscription of advisor a.

Definition at line 196 of file cached.hpp.

## modevent()

template<class View>

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

inline static

Return modification event.

Definition at line 224 of file cached.hpp.

## glbMin() [2/2]

template<class View>

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

inline

Return minimum value just pruned from glb.

Definition at line 230 of file cached.hpp.

## glbMax() [2/2]

template<class View>

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

inline

Return maximum value just pruned from glb.

Definition at line 236 of file cached.hpp.

## glbAny()

template<class View>

bool Gecode::Set::CachedView< View >::glbAny | ( | const Delta & | d | ) | const

inline

Test whether arbitrary values got pruned from glb.

Definition at line 242 of file cached.hpp.

## lubMin() [2/2]

template<class View>

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

inline

Return minimum value just pruned from lub.

Definition at line 248 of file cached.hpp.

## lubMax() [2/2]

template<class View>

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

inline

Return maximum value just pruned from lub.

Definition at line 254 of file cached.hpp.

## lubAny()

template<class View>

bool Gecode::Set::CachedView< View >::lubAny | ( | const Delta & | d | ) | const

inline

Test whether arbitrary values got pruned from lub.

Definition at line 260 of file cached.hpp.

## initCache()

template<class View>

void Gecode::Set::CachedView< View >::initCache | ( | Space & | home,
|  | const IntSet & | glb,
|  | const IntSet & | lub )

Initialize cache to bounds glb and lub.

Definition at line 278 of file cached.hpp.

## cacheGlb()

template<class View>

void Gecode::Set::CachedView< View >::cacheGlb | ( | Space & | home | ) |

inline

Update greatest lower bound cache to current domain.

Definition at line 290 of file cached.hpp.

## cacheLub()

template<class View>

void Gecode::Set::CachedView< View >::cacheLub | ( | Space & | home | ) |

inline

Update least upper bound cache to current domain.

Definition at line 297 of file cached.hpp.

## glbModified()

template<class View>

bool Gecode::Set::CachedView< View >::glbModified | ( | void |  | ) | const

inline

Check whether greatest lower bound cache differs from current domain.

Definition at line 304 of file cached.hpp.

## lubModified()

template<class View>

bool Gecode::Set::CachedView< View >::lubModified | ( | void |  | ) | const

inline

Check whether least upper bound cache differs from current domain.

Definition at line 310 of file cached.hpp.

## update()

template<class View>

void Gecode::Set::CachedView< View >::update | ( | Space & | home,
|  | CachedView< View > & | y )

Update this view to be a clone of view y.

## excludeI() [2/2]

template<class View>
template<class I>

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

Definition at line 159 of file cached.hpp.

## includeI() [2/2]

template<class View>
template<class I>

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

Definition at line 165 of file cached.hpp.

## intersectI() [2/2]

template<class View>
template<class I>

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

Definition at line 171 of file cached.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 CachedView< View > & | x )

related

Print cached set view.

Definition at line 67 of file print.hpp.

## operator==()

template<class View>

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

related

Test whether views x and y are the same.

Definition at line 401 of file cached.hpp.

## operator!=()

template<class View>

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

related

Test whether views x and y are the not same.

Definition at line 406 of file cached.hpp.

## Member Data Documentation

## lubCache

template<class View>

LUBndSet Gecode::Set::CachedView< View >::lubCache

protected

The cached least upper bound.

Definition at line 955 of file view.hpp.

## glbCache

template<class View>

GLBndSet Gecode::Set::CachedView< View >::glbCache

protected

The cached greatest lower bound.

Definition at line 957 of file view.hpp.

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

- gecode/set/view.hpp
- gecode/set/view/cached.hpp