Generated on Fri Oct 19 11:26:04 2018 for Gecode by doxygen 1.6.3

Gecode::Int::CachedView< View > Class Template Reference
[Integer views]

Cached integer view. More...

#include <view.hpp>

List of all members.

Protected Attributes

RangeList_firstRange
 First cached range.
RangeList_lastRange
 Last cached range.
unsigned int _size
 Size of cached domain.

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 cached view.

Constructors and initialization



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

Value access



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

Domain tests



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

Domain update by value



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

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

Delta information for advisors



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

Domain cache operations



void initCache (Space &home, const IntSet &s)
 Initialize cache to set s.
void cache (Space &home)
 Update cache to current domain.
bool modified (void) const
 Check whether 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 ModEventDelta med (ModEvent me)
 Translate modification event me to modification event delta for view.

View comparison



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 not the same.

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 1166 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  )  [inline, explicit]

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 93 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 88 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 98 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 103 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 113 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 118 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 123 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 134 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 139 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 144 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 149 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 154 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 159 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 164 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 169 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 174 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 179 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 184 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 189 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 201 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 207 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 213 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 219 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 225 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 231 of file cached.hpp.

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

Translate modification event me to modification event delta for view.

Reimplemented from Gecode::DerivedView< View >.

Definition at line 243 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 254 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 259 of file cached.hpp.

template<class View >
unsigned int Gecode::Int::CachedView< View >::width ( const Delta d  )  const [inline]

Return width of values just pruned.

Definition at line 264 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 269 of file cached.hpp.

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

Initialize cache to set s.

Definition at line 307 of file cached.hpp.

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

Update cache to current domain.

Definition at line 319 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 336 of file cached.hpp.

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

Update this view to be a clone of view y.

Definition at line 281 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 cached view.

Print cached set view.

Definition at line 108 of file print.hpp.

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.

template<class View >
bool operator!= ( const CachedView< View > &  x,
const CachedView< View > &  y 
) [related]

Test whether views x and y are not the same.

Test whether views x and y are the not same.

Definition at line 406 of file cached.hpp.


Member Data Documentation

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

First cached range.

Definition at line 1171 of file view.hpp.

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

Last cached range.

Definition at line 1173 of file view.hpp.

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

Size of cached domain.

Definition at line 1175 of file view.hpp.


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