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

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

Zero integer view. More...

#include <view.hpp>

List of all members.

Constructors and initialization



 ZeroIntView (void)
 Default constructor.

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 comparison



bool same (const ZeroIntView &x, const ZeroIntView &y)
 Test whether views x and y are the same.

Detailed Description

Zero integer view.

A zero integer view $x$ for provides operations such that $x$ behaves as a view assigned to $0$.

Definition at line 969 of file view.hpp.


Constructor & Destructor Documentation

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

Default constructor.

Definition at line 45 of file zero.hpp.


Member Function Documentation

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

Return minimum of domain.

Definition at line 52 of file zero.hpp.

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

Return maximum of domain.

Definition at line 56 of file zero.hpp.

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

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

Definition at line 60 of file zero.hpp.

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

Return assigned value (only if assigned).

Definition at line 64 of file zero.hpp.

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

Return size (cardinality) of domain.

Definition at line 69 of file zero.hpp.

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

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

Definition at line 73 of file zero.hpp.

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

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

Definition at line 77 of file zero.hpp.

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

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

Definition at line 81 of file zero.hpp.

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

Test whether domain is a range.

Definition at line 91 of file zero.hpp.

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

Test whether n is contained in domain.

Definition at line 95 of file zero.hpp.

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

Test whether n is contained in domain.

Definition at line 99 of file zero.hpp.

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

Restrict domain values to be less or equal than n.

Definition at line 109 of file zero.hpp.

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

Restrict domain values to be less or equal than n.

Definition at line 113 of file zero.hpp.

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

Restrict domain values to be less than n.

Definition at line 118 of file zero.hpp.

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

Restrict domain values to be less than n.

Definition at line 122 of file zero.hpp.

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

Restrict domain values to be greater or equal than n.

Definition at line 127 of file zero.hpp.

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

Restrict domain values to be greater or equal than n.

Definition at line 131 of file zero.hpp.

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

Restrict domain values to be greater than n.

Definition at line 136 of file zero.hpp.

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

Restrict domain values to be greater than n.

Definition at line 140 of file zero.hpp.

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

Restrict domain values to be different from n.

Definition at line 145 of file zero.hpp.

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

Restrict domain values to be different from n.

Definition at line 149 of file zero.hpp.

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

Restrict domain values to be equal to n.

Definition at line 154 of file zero.hpp.

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

Restrict domain values to be equal to n.

Definition at line 158 of file zero.hpp.

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

Replace domain by ranges described by i.

Definition at line 170 of file zero.hpp.

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

Intersect domain with ranges described by i.

Definition at line 175 of file zero.hpp.

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

Remove from domain the ranges described by i.

Definition at line 182 of file zero.hpp.

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

Replace domain by values described by i.

Definition at line 189 of file zero.hpp.

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

Intersect domain with values described by i.

Definition at line 194 of file zero.hpp.

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

Remove from domain the values described by i.

Definition at line 201 of file zero.hpp.

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

Return minimum value just pruned.

Definition at line 212 of file zero.hpp.

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

Return maximum value just pruned.

Definition at line 216 of file zero.hpp.

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

Test whether arbitrary values got pruned.

Definition at line 220 of file zero.hpp.


Friends And Related Function Documentation

bool same ( const ZeroIntView x,
const ZeroIntView y 
) [related]

Test whether views x and y are the same.

Definition at line 298 of file zero.hpp.


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