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

Cached integer view. More...

#include <view.hpp>

Protected Attributes

RangeList_firstRange
 First cached range. More...
 
RangeList_lastRange
 Last cached range. More...
 
unsigned int _size
 Size of cached domain. 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 integer offset view. More...
 

View comparison

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

Constructors and initialization

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

Value access

int min (void) const
 Return minimum of domain. More...
 
int max (void) const
 Return maximum of domain. More...
 
int med (void) const
 Return median of domain (greatest element not greater than the median) More...
 
int val (void) const
 Return assigned value (only if assigned) More...
 
unsigned int size (void) const
 Return size (cardinality) of domain. More...
 
unsigned int width (void) const
 Return width of domain (distance between maximum and minimum) More...
 
unsigned int regret_min (void) const
 Return regret of domain minimum (distance to next larger value) More...
 
unsigned int regret_max (void) const
 Return regret of domain maximum (distance to next smaller value) More...
 

Domain tests

bool range (void) const
 Test whether domain is a range. More...
 
bool in (int n) const
 Test whether n is contained in domain. More...
 
bool in (long long int n) const
 Test whether n is contained in domain. More...
 

Domain update by value

ModEvent lq (Space &home, int n)
 Restrict domain values to be less or equal than n. More...
 
ModEvent lq (Space &home, long long int n)
 Restrict domain values to be less or equal than n. More...
 
ModEvent le (Space &home, int n)
 Restrict domain values to be less than n. More...
 
ModEvent le (Space &home, long long int n)
 Restrict domain values to be less than n. More...
 
ModEvent gq (Space &home, int n)
 Restrict domain values to be greater or equal than n. More...
 
ModEvent gq (Space &home, long long int n)
 Restrict domain values to be greater or equal than n. More...
 
ModEvent gr (Space &home, int n)
 Restrict domain values to be greater than n. More...
 
ModEvent gr (Space &home, long long int n)
 Restrict domain values to be greater than n. More...
 
ModEvent nq (Space &home, int n)
 Restrict domain values to be different from n. More...
 
ModEvent nq (Space &home, long long int n)
 Restrict domain values to be different from n. More...
 
ModEvent eq (Space &home, int n)
 Restrict domain values to be equal to n. More...
 
ModEvent eq (Space &home, long long int n)
 Restrict domain values to be equal to n. More...
 

Domain update by iterator

Views can be both updated by range and value iterators. Value iterators do not need to be strict in that the same value is allowed to occur more than once in the iterated sequence.

The argument depends must be true, if the iterator passed as argument depends on the view on which the operation is invoked. In this case, the view is only updated after the iterator has been consumed. Otherwise, the domain might be updated concurrently while following the iterator.

template<class I >
ModEvent narrow_r (Space &home, I &i, bool depends=true)
 Replace domain by ranges described by i. More...
 
template<class I >
ModEvent inter_r (Space &home, I &i, bool depends=true)
 Intersect domain with ranges described by i. More...
 
template<class I >
ModEvent minus_r (Space &home, I &i, bool depends=true)
 Remove from domain the ranges described by i. More...
 
template<class I >
ModEvent narrow_v (Space &home, I &i, bool depends=true)
 Replace domain by values described by i. More...
 
template<class I >
ModEvent inter_v (Space &home, I &i, bool depends=true)
 Intersect domain with values described by i. More...
 
template<class I >
ModEvent minus_v (Space &home, I &i, bool depends=true)
 Remove from domain the values described by i. More...
 

View-dependent propagator support

static ModEventDelta med (ModEvent me)
 Translate modification event me to modification event delta for view. More...
 

Delta information for advisors

int min (const Delta &d) const
 Return minimum value just pruned. More...
 
int max (const Delta &d) const
 Return maximum value just pruned. More...
 
bool any (const Delta &d) const
 Test whether arbitrary values got pruned. More...
 

Domain cache operations

void initCache (Space &home, const IntSet &s)
 Initialize cache to set s. More...
 
void cache (Space &home)
 Update cache to current domain. More...
 
bool modified (void) const
 Check whether 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...
 
- 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...
 
- 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::Int::CachedView< View >

Cached integer view.

A cached integer view $c$ for an integer view $x$ adds operations for cacheing the current domain of $x$ and comparing the current domain to the cached domain. Cached views make it easy to implement incremental propagation algorithms.

Definition at line 1107 of file view.hpp.

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 46 of file cached.hpp.

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

Initialize with integer view y.

Definition at line 49 of file cached.hpp.

Member Function Documentation

template<class View >
int Gecode::Int::CachedView< View >::min ( void  ) const
inline

Return minimum of domain.

Definition at line 60 of file cached.hpp.

template<class View >
int Gecode::Int::CachedView< View >::max ( void  ) const
inline

Return maximum of domain.

Definition at line 65 of file cached.hpp.

template<class View >
int Gecode::Int::CachedView< View >::med ( void  ) const
inline

Return median of domain (greatest element not greater than the median)

Definition at line 70 of file cached.hpp.

template<class View >
int Gecode::Int::CachedView< View >::val ( void  ) const
inline

Return assigned value (only if assigned)

Definition at line 75 of file cached.hpp.

template<class View >
unsigned int Gecode::Int::CachedView< View >::size ( void  ) const
inline

Return size (cardinality) of domain.

Definition at line 86 of file cached.hpp.

template<class View >
unsigned int Gecode::Int::CachedView< View >::width ( void  ) const
inline

Return width of domain (distance between maximum and minimum)

Definition at line 81 of file cached.hpp.

template<class View >
unsigned int Gecode::Int::CachedView< View >::regret_min ( void  ) const
inline

Return regret of domain minimum (distance to next larger value)

Definition at line 91 of file cached.hpp.

template<class View >
unsigned int Gecode::Int::CachedView< View >::regret_max ( void  ) const
inline

Return regret of domain maximum (distance to next smaller value)

Definition at line 96 of file cached.hpp.

template<class View >
bool Gecode::Int::CachedView< View >::range ( void  ) const
inline

Test whether domain is a range.

Definition at line 106 of file cached.hpp.

template<class View >
bool Gecode::Int::CachedView< View >::in ( int  n) const
inline

Test whether n is contained in domain.

Definition at line 111 of file cached.hpp.

template<class View >
bool Gecode::Int::CachedView< View >::in ( long long int  n) const
inline

Test whether n is contained in domain.

Definition at line 116 of file cached.hpp.

template<class View >
ModEvent Gecode::Int::CachedView< View >::lq ( Space home,
int  n 
)
inline

Restrict domain values to be less or equal than n.

Definition at line 127 of file cached.hpp.

template<class View >
ModEvent Gecode::Int::CachedView< View >::lq ( Space home,
long long int  n 
)
inline

Restrict domain values to be less or equal than n.

Definition at line 132 of file cached.hpp.

template<class View >
ModEvent Gecode::Int::CachedView< View >::le ( Space home,
int  n 
)
inline

Restrict domain values to be less than n.

Definition at line 137 of file cached.hpp.

template<class View >
ModEvent Gecode::Int::CachedView< View >::le ( Space home,
long long int  n 
)
inline

Restrict domain values to be less than n.

Definition at line 142 of file cached.hpp.

template<class View >
ModEvent Gecode::Int::CachedView< View >::gq ( Space home,
int  n 
)
inline

Restrict domain values to be greater or equal than n.

Definition at line 147 of file cached.hpp.

template<class View >
ModEvent Gecode::Int::CachedView< View >::gq ( Space home,
long long int  n 
)
inline

Restrict domain values to be greater or equal than n.

Definition at line 152 of file cached.hpp.

template<class View >
ModEvent Gecode::Int::CachedView< View >::gr ( Space home,
int  n 
)
inline

Restrict domain values to be greater than n.

Definition at line 157 of file cached.hpp.

template<class View >
ModEvent Gecode::Int::CachedView< View >::gr ( Space home,
long long int  n 
)
inline

Restrict domain values to be greater than n.

Definition at line 162 of file cached.hpp.

template<class View >
ModEvent Gecode::Int::CachedView< View >::nq ( Space home,
int  n 
)
inline

Restrict domain values to be different from n.

Definition at line 167 of file cached.hpp.

template<class View >
ModEvent Gecode::Int::CachedView< View >::nq ( Space home,
long long int  n 
)
inline

Restrict domain values to be different from n.

Definition at line 172 of file cached.hpp.

template<class View >
ModEvent Gecode::Int::CachedView< View >::eq ( Space home,
int  n 
)
inline

Restrict domain values to be equal to n.

Definition at line 177 of file cached.hpp.

template<class View >
ModEvent Gecode::Int::CachedView< View >::eq ( Space home,
long long int  n 
)
inline

Restrict domain values to be equal to n.

Definition at line 182 of file cached.hpp.

template<class View >
template<class I >
ModEvent Gecode::Int::CachedView< View >::narrow_r ( Space home,
I &  i,
bool  depends = true 
)
inline

Replace domain by ranges described by i.

Definition at line 194 of file cached.hpp.

template<class View >
template<class I >
ModEvent Gecode::Int::CachedView< View >::inter_r ( Space home,
I &  i,
bool  depends = true 
)
inline

Intersect domain with ranges described by i.

Definition at line 200 of file cached.hpp.

template<class View >
template<class I >
ModEvent Gecode::Int::CachedView< View >::minus_r ( Space home,
I &  i,
bool  depends = true 
)
inline

Remove from domain the ranges described by i.

Definition at line 206 of file cached.hpp.

template<class View >
template<class I >
ModEvent Gecode::Int::CachedView< View >::narrow_v ( Space home,
I &  i,
bool  depends = true 
)
inline

Replace domain by values described by i.

Definition at line 212 of file cached.hpp.

template<class View >
template<class I >
ModEvent Gecode::Int::CachedView< View >::inter_v ( Space home,
I &  i,
bool  depends = true 
)
inline

Intersect domain with values described by i.

Definition at line 218 of file cached.hpp.

template<class View >
template<class I >
ModEvent Gecode::Int::CachedView< View >::minus_v ( Space home,
I &  i,
bool  depends = true 
)
inline

Remove from domain the values described by i.

Definition at line 224 of file cached.hpp.

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

Translate modification event me to modification event delta for view.

Definition at line 236 of file cached.hpp.

template<class View >
int Gecode::Int::CachedView< View >::min ( const Delta d) const
inline

Return minimum value just pruned.

Definition at line 247 of file cached.hpp.

template<class View >
int Gecode::Int::CachedView< View >::max ( const Delta d) const
inline

Return maximum value just pruned.

Definition at line 252 of file cached.hpp.

template<class View >
bool Gecode::Int::CachedView< View >::any ( const Delta d) const
inline

Test whether arbitrary values got pruned.

Definition at line 257 of file cached.hpp.

template<class View >
void Gecode::Int::CachedView< View >::initCache ( Space home,
const IntSet s 
)

Initialize cache to set s.

Definition at line 295 of file cached.hpp.

template<class View >
void Gecode::Int::CachedView< View >::cache ( Space home)

Update cache to current domain.

Definition at line 307 of file cached.hpp.

template<class View >
bool Gecode::Int::CachedView< View >::modified ( void  ) const
inline

Check whether cache differs from current domain.

Definition at line 324 of file cached.hpp.

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

Update this view to be a clone of view y.

Definition at line 269 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 integer offset view.

Definition at line 112 of file print.hpp.

template<class View >
bool same ( const CachedView< View > &  x,
const CachedView< View > &  y 
)
related

Test whether views x and y are the same.

Definition at line 389 of file cached.hpp.

template<class View >
bool before ( const CachedView< View > &  x,
const CachedView< View > &  y 
)
related

Test whether view x comes before y (arbitrary order)

Definition at line 394 of file cached.hpp.

Member Data Documentation

template<class View>
RangeList* Gecode::Int::CachedView< View >::_firstRange
protected

First cached range.

Definition at line 1112 of file view.hpp.

template<class View>
RangeList* Gecode::Int::CachedView< View >::_lastRange
protected

Last cached range.

Definition at line 1114 of file view.hpp.

template<class View>
unsigned int Gecode::Int::CachedView< View >::_size
protected

Size of cached domain.

Definition at line 1116 of file view.hpp.


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