Generated on Thu Mar 22 10:39:55 2012 for Gecode by doxygen 1.6.3

Gecode::Int::IntView Class Reference
[Integer views]

Integer view for integer variables. More...

#include <view.hpp>

List of all members.

Related Functions

(Note that these are not member functions.)



template<class Char , class Traits >
std::basic_ostream< Char,
Traits > & 
operator<< (std::basic_ostream< Char, Traits > &os, const IntView &x)
 Print integer variable view.

Constructors and initialization



 IntView (void)
 Default constructor.
 IntView (const IntVar &y)
 Initialize from integer variable y.
 IntView (IntVarImp *y)
 Initialize from integer variable 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 (double 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, double 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, double 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, double 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, double 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, double 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, double 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.
bool any (const Delta &d) const
 Test whether arbitrary values got pruned.

View-dependent propagator support



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

Detailed Description

Integer view for integer variables.

Definition at line 135 of file view.hpp.


Constructor & Destructor Documentation

Gecode::Int::IntView::IntView ( void   )  [inline]

Default constructor.

Definition at line 45 of file int.hpp.

Gecode::Int::IntView::IntView ( const IntVar y  )  [inline]

Initialize from integer variable y.

Definition at line 47 of file int.hpp.

Gecode::Int::IntView::IntView ( IntVarImp y  )  [inline]

Initialize from integer variable y.

Definition at line 50 of file int.hpp.


Member Function Documentation

int Gecode::Int::IntView::min ( void   )  const [inline]

Return minimum of domain.

Definition at line 58 of file int.hpp.

int Gecode::Int::IntView::max ( void   )  const [inline]

Return maximum of domain.

Definition at line 62 of file int.hpp.

int Gecode::Int::IntView::med ( void   )  const [inline]

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

Definition at line 66 of file int.hpp.

int Gecode::Int::IntView::val ( void   )  const [inline]

Return assigned value (only if assigned).

Definition at line 70 of file int.hpp.

unsigned int Gecode::Int::IntView::size ( void   )  const [inline]

Return size (cardinality) of domain.

Definition at line 75 of file int.hpp.

unsigned int Gecode::Int::IntView::width ( void   )  const [inline]

Return width of domain (distance between maximum and minimum).

Definition at line 79 of file int.hpp.

unsigned int Gecode::Int::IntView::regret_min ( void   )  const [inline]

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

Definition at line 83 of file int.hpp.

unsigned int Gecode::Int::IntView::regret_max ( void   )  const [inline]

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

Definition at line 87 of file int.hpp.

bool Gecode::Int::IntView::range ( void   )  const [inline]

Test whether domain is a range.

Definition at line 97 of file int.hpp.

bool Gecode::Int::IntView::in ( int  n  )  const [inline]

Test whether n is contained in domain.

Definition at line 101 of file int.hpp.

bool Gecode::Int::IntView::in ( double  n  )  const [inline]

Test whether n is contained in domain.

Definition at line 105 of file int.hpp.

ModEvent Gecode::Int::IntView::lq ( Space home,
int  n 
) [inline]

Restrict domain values to be less or equal than n.

Definition at line 115 of file int.hpp.

ModEvent Gecode::Int::IntView::lq ( Space home,
double  n 
) [inline]

Restrict domain values to be less or equal than n.

Definition at line 119 of file int.hpp.

ModEvent Gecode::Int::IntView::le ( Space home,
int  n 
) [inline]

Restrict domain values to be less than n.

Definition at line 124 of file int.hpp.

ModEvent Gecode::Int::IntView::le ( Space home,
double  n 
) [inline]

Restrict domain values to be less than n.

Definition at line 128 of file int.hpp.

ModEvent Gecode::Int::IntView::gq ( Space home,
int  n 
) [inline]

Restrict domain values to be greater or equal than n.

Definition at line 133 of file int.hpp.

ModEvent Gecode::Int::IntView::gq ( Space home,
double  n 
) [inline]

Restrict domain values to be greater or equal than n.

Definition at line 137 of file int.hpp.

ModEvent Gecode::Int::IntView::gr ( Space home,
int  n 
) [inline]

Restrict domain values to be greater than n.

Definition at line 142 of file int.hpp.

ModEvent Gecode::Int::IntView::gr ( Space home,
double  n 
) [inline]

Restrict domain values to be greater than n.

Definition at line 146 of file int.hpp.

ModEvent Gecode::Int::IntView::nq ( Space home,
int  n 
) [inline]

Restrict domain values to be different from n.

Definition at line 151 of file int.hpp.

ModEvent Gecode::Int::IntView::nq ( Space home,
double  n 
) [inline]

Restrict domain values to be different from n.

Definition at line 155 of file int.hpp.

ModEvent Gecode::Int::IntView::eq ( Space home,
int  n 
) [inline]

Restrict domain values to be equal to n.

Definition at line 160 of file int.hpp.

ModEvent Gecode::Int::IntView::eq ( Space home,
double  n 
) [inline]

Restrict domain values to be equal to n.

Definition at line 164 of file int.hpp.

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

Replace domain by ranges described by i.

Definition at line 175 of file int.hpp.

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

Intersect domain with ranges described by i.

Definition at line 180 of file int.hpp.

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

Remove from domain the ranges described by i.

Definition at line 185 of file int.hpp.

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

Replace domain by values described by i.

Definition at line 190 of file int.hpp.

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

Intersect domain with values described by i.

Definition at line 195 of file int.hpp.

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

Remove from domain the values described by i.

Definition at line 200 of file int.hpp.

int Gecode::Int::IntView::min ( const Delta d  )  const [inline]

Return minimum value just pruned.

Definition at line 212 of file int.hpp.

int Gecode::Int::IntView::max ( const Delta d  )  const [inline]

Return maximum value just pruned.

Definition at line 216 of file int.hpp.

bool Gecode::Int::IntView::any ( const Delta d  )  const [inline]

Test whether arbitrary values got pruned.

Definition at line 220 of file int.hpp.

ModEventDelta Gecode::Int::IntView::med ( ModEvent  me  )  [inline, static]

Translate modification event me to modification event delta for view.

Reimplemented from Gecode::VarImpView< IntVar >.

Definition at line 226 of file int.hpp.


Friends And Related Function Documentation

template<class Char , class Traits >
std::basic_ostream< Char, Traits > & operator<< ( std::basic_ostream< Char, Traits > &  os,
const IntView x 
) [related]

Print integer variable view.

Definition at line 97 of file print.hpp.


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