Generated on Sat Feb 7 2015 02:01:51 for Gecode by doxygen 1.8.9.1
Gecode::Set::CachedView< View > Class Template Reference

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 >
VarImpTypevarimp (void) const
 Return variable implementation of view. More...
 
View base (void) const
 Return view from which this view is derived. More...
 
unsigned int degree (void) const
 Return degree (number of subscribed propagators) More...
 
double afc (const Space &home) const
 Return accumulated failure count. More...
 
bool assigned (void) const
 Test whether view is assigned. More...
 
void subscribe (Space &home, Propagator &p, PropCond pc, bool schedule=true)
 Subscribe propagator p with propagation condition pc to view. More...
 
void cancel (Space &home, Propagator &p, PropCond pc)
 Cancel subscription of propagator p with propagation condition pc to view. More...
 
void subscribe (Space &home, Advisor &a)
 Subscribe advisor a to view. More...
 
void cancel (Space &home, Advisor &a)
 Cancel subscription of advisor a. More...
 
void update (Space &home, bool share, DerivedView< View > &y)
 Update this view to be a clone of view y. More...
 

Protected Attributes

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

Related Functions

(Note that these are not member functions.)

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

Constructors and initialization

 CachedView (void)
 Default constructor. More...
 
 CachedView (const View &y)
 Initialize with set view y. More...
 

Value access

unsigned int cardMin (void) const
 Return minimum cardinality. More...
 
unsigned int cardMax (void) const
 Return maximum cardinality. More...
 
int lubMin (void) const
 Return minimum of the least upper bound. More...
 
int lubMax (void) const
 Return maximum of the least upper bound. More...
 
int lubMinN (unsigned int n) const
 Return n-th smallest element of the least upper bound. More...
 
int glbMin (void) const
 Return minimum of the greatest lower bound. More...
 
int glbMax (void) const
 Return maximum of the greatest lower bound. More...
 
unsigned int glbSize (void) const
 Return the number of elements in the greatest lower bound. More...
 
unsigned int lubSize (void) const
 Return the number of elements in the least upper bound. More...
 
unsigned int unknownSize (void) const
 Return the number of unknown elements. More...
 

Domain tests

bool contains (int i) const
 Test whether i is in the greatest lower bound. More...
 
bool notContains (int i) const
 Test whether i is not in the least upper bound. More...
 

Domain update by value

ModEvent cardMin (Space &home, unsigned int m)
 Restrict cardinality to be greater than or equal to m. More...
 
ModEvent cardMax (Space &home, unsigned int m)
 Restrict cardinality to be less than or equal to m. More...
 
ModEvent include (Space &home, int i, int j)
 Update greatest lower bound to include all elements between and including i and j. More...
 
ModEvent exclude (Space &home, int i, int j)
 Restrict least upper bound to not contain all elements between and including i and j. More...
 
ModEvent include (Space &home, int i)
 Update greatest lower bound to contain i. More...
 
ModEvent exclude (Space &home, int i)
 Restrict least upper bound to not contain i. More...
 
ModEvent intersect (Space &home, int i, int j)
 Update least upper bound to contain at most all elements between and including i and j. More...
 
ModEvent intersect (Space &home, int i)
 Update least upper bound to contain at most the element i. More...
 

Domain update by range iterator

template<class I >
ModEvent excludeI (Space &home, I &i)
 Remove range sequence described by i from least upper bound. More...
 
template<class I >
ModEvent includeI (Space &home, I &i)
 Include range sequence described by i in greatest lower bound. More...
 
template<class I >
ModEvent intersectI (Space &home, I &iter)
 Intersect least upper bound with range sequence described by i. More...
 

View-dependent propagator support

static void schedule (Space &home, Propagator &p, ModEvent me)
 Schedule propagator p with modification event me. More...
 
static ModEvent me (const ModEventDelta &med)
 Return modification event for view type in med. More...
 
static ModEventDelta med (ModEvent)
 Translate modification event me to modification event delta for view. More...
 

Dependencies

void subscribe (Space &home, Propagator &p, PropCond pc, bool schedule=true)
 Subscribe propagator p with propagation condition pc to view. More...
 
void cancel (Space &home, Propagator &p, PropCond pc)
 Cancel subscription of propagator p with propagation condition pc to view. More...
 
void subscribe (Space &home, Advisor &a)
 Subscribe advisor a to view. More...
 
void cancel (Space &home, Advisor &a)
 Cancel subscription of advisor a. More...
 

Delta information for advisors

int glbMin (const Delta &d) const
 Return minimum value just pruned from glb. More...
 
int glbMax (const Delta &d) const
 Return maximum value just pruned from glb. More...
 
bool glbAny (const Delta &d) const
 Test whether arbitrary values got pruned from glb. More...
 
int lubMin (const Delta &d) const
 Return minimum value just pruned from lub. More...
 
int lubMax (const Delta &d) const
 Return maximum value just pruned from lub. More...
 
bool lubAny (const Delta &d) const
 Test whether arbitrary values got pruned from lub. More...
 
static ModEvent modevent (const Delta &d)
 Return modification event. More...
 

Domain cache operations

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

Cloning

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

Additional Inherited Members

- Public Types inherited from Gecode::DerivedView< View >
typedef View::VarImpType VarImpType
 The variable implementation type belonging to the View. More...
 
typedef View::VarType VarType
 The variable type belonging to the View. More...
 
- Static Public Member Functions inherited from Gecode::DerivedView< View >
static bool varderived (void)
 Return whether this view is derived from a VarImpView. More...
 
static void schedule (Space &home, Propagator &p, ModEvent me)
 Schedule propagator p with modification event me. More...
 
static ModEvent me (const ModEventDelta &med)
 Return modification event for view type in med. More...
 
static ModEventDelta med (ModEvent)
 Translate modification event me to modification event delta for view. More...
 
static ModEvent modevent (const Delta &d)
 Return modification event. More...
 
- Protected Member Functions inherited from Gecode::DerivedView< View >
 DerivedView (void)
 Default constructor. More...
 
 DerivedView (const View &y)
 Initialize with view y. More...
 

Detailed Description

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

Cached set view.

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

Definition at line 921 of file view.hpp.

Constructor & Destructor Documentation

template<class View >
Gecode::Set::CachedView< View >::CachedView ( void  )

Default constructor.

template<class View >
Gecode::Set::CachedView< View >::CachedView ( const View &  y)
explicit

Initialize with set view y.

Member Function Documentation

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

Return minimum cardinality.

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

Return maximum cardinality.

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

Return minimum of the least upper bound.

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

Return maximum of the least upper bound.

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

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

template<class View >
int Gecode::Set::CachedView< View >::glbMin ( void  ) const

Return minimum of the greatest lower bound.

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

Return maximum of the greatest lower bound.

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 53 of file cached.hpp.

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 59 of file cached.hpp.

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

Return the number of unknown elements.

Definition at line 65 of file cached.hpp.

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 71 of file cached.hpp.

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

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 115 of file cached.hpp.

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 121 of file cached.hpp.

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 151 of file cached.hpp.

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 157 of file cached.hpp.

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

Update greatest lower bound to contain i.

Definition at line 127 of file cached.hpp.

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 133 of file cached.hpp.

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 145 of file cached.hpp.

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 139 of file cached.hpp.

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.

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.

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.

template<class View >
void Gecode::Set::CachedView< View >::schedule ( Space home,
Propagator p,
ModEvent  me 
)
inlinestatic

Schedule propagator p with modification event me.

Definition at line 206 of file cached.hpp.

template<class View >
ModEvent Gecode::Set::CachedView< View >::me ( const ModEventDelta med)
inlinestatic

Return modification event for view type in med.

Definition at line 211 of file cached.hpp.

template<class View >
static ModEventDelta Gecode::Set::CachedView< View >::med ( ModEvent  )
static

Translate modification event me to modification event delta for view.

template<class View >
void Gecode::Set::CachedView< View >::subscribe ( Space home,
Propagator p,
PropCond  pc,
bool  schedule = true 
)

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

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 188 of file cached.hpp.

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

Subscribe advisor a to view.

Definition at line 194 of file cached.hpp.

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

Cancel subscription of advisor a.

Definition at line 200 of file cached.hpp.

template<class View >
ModEvent Gecode::Set::CachedView< View >::modevent ( const Delta d)
inlinestatic

Return modification event.

Definition at line 228 of file cached.hpp.

template<class View >
int Gecode::Set::CachedView< View >::glbMin ( const Delta d) const

Return minimum value just pruned from glb.

template<class View >
int Gecode::Set::CachedView< View >::glbMax ( const Delta d) const

Return maximum value just pruned from glb.

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 246 of file cached.hpp.

template<class View >
int Gecode::Set::CachedView< View >::lubMin ( const Delta d) const

Return minimum value just pruned from lub.

template<class View >
int Gecode::Set::CachedView< View >::lubMax ( const Delta d) const

Return maximum value just pruned from lub.

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 264 of file cached.hpp.

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 282 of file cached.hpp.

template<class View >
void Gecode::Set::CachedView< View >::cacheGlb ( Space home)
inline

Update greatest lower bound cache to current domain.

Definition at line 294 of file cached.hpp.

template<class View >
void Gecode::Set::CachedView< View >::cacheLub ( Space home)
inline

Update least upper bound cache to current domain.

Definition at line 301 of file cached.hpp.

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 308 of file cached.hpp.

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 314 of file cached.hpp.

template<class View >
void Gecode::Set::CachedView< View >::update ( Space home,
bool  share,
CachedView< View > &  y 
)

Update this view to be a clone of view y.

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

Definition at line 163 of file cached.hpp.

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

Definition at line 169 of file cached.hpp.

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

Definition at line 175 of file cached.hpp.

Friends And Related Function Documentation

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 112 of file print.hpp.

Member Data Documentation

template<class View >
LUBndSet Gecode::Set::CachedView< View >::lubCache
protected

The cached least upper bound.

Definition at line 929 of file view.hpp.

template<class View >
GLBndSet Gecode::Set::CachedView< View >::glbCache
protected

The cached greatest lower bound.

Definition at line 931 of file view.hpp.


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