Gecode::Int::ConstIntView Class Reference
Functionality by programming task » Programming actors » Programming integer actors » Integer views

Constant integer view. More...

`#include <view.hpp>`

## Protected Attributes

int | x

## Constructors and initialization

| ConstIntView (void)
| Default constructor.
| ConstIntView (int n)
| Initialize with integer value n.

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

## Cloning

void | update (Space &home, ConstIntView &y)
| Update this view to be a clone of view y.

## Ordering

bool | operator< (const ConstIntView &y) const
| Whether this view comes before view y (arbitray order).

## View comparison

template<class Char, class Traits>
std::basic_ostream< Char, Traits > & | operator<< (std::basic_ostream< Char, Traits > &os, const ConstIntView &x)
| Print integer constant integer view.
bool | operator== (const ConstIntView &x, const ConstIntView &y)
| Test whether views x and y are the same.
bool | operator!= (const ConstIntView &x, const ConstIntView &y)
| Test whether views x and y are not the same.

## Additional Inherited Members

Public Types inherited from Gecode::ConstView< IntView >
typedef IntView::VarImpType | VarImpType
| The variable implementation type corresponding to the constant view.
typedef IntView::VarType | VarType
| The variable type corresponding to the constant view.
unsigned int | degree (void) const
| Return degree (number of subscribed propagators and advisors).
double | afc (void) const
| Return accumulated failure count.
VarImpType * | varimp (void) const
| Return dummy variable implementation of view.
bool | assigned (void) const
| Test whether view is assigned.
void | subscribe (Space &home, Propagator &p, PropCond pc, bool schedule=true)
| Subscribe propagator p with propagation condition pc to view.
void | cancel (Space &home, Propagator &p, PropCond pc)
| Cancel subscription of propagator p with propagation condition pc to view.
void | reschedule (Space &home, Propagator &p, PropCond pc)
| Re-schedule propagator p with propagation condition pc.
void | update (Space &home, ConstView &y)
| Update this view to be a clone of view y.
bool | operator< (const ConstView &y) const
| Whether this view comes before view y (arbitray order).
static bool | varderived (void)
| Return whether this view is derived from a VarImpView.
static void | schedule (Space &home, Propagator &p, ModEvent me)
| Schedule propagator p with modification event me.
static ModEvent | me (const ModEventDelta &med)
| Return modification event for view type in med.
static ModEventDelta | med (ModEvent me)
| Translate modification event me to modification event delta for view.
static ModEvent | modevent (const Delta &d)
| Return modification event.

## Detailed Description

Constant integer view.

A constant integer view for an integer provides operations such that behaves as a view assigned to .

Definition at line 851 of file view.hpp.

## Constructor & Destructor Documentation

## ConstIntView() [1/2]

Gecode::Int::ConstIntView::ConstIntView | ( | void |  | ) |

inline

Default constructor.

Definition at line 41 of file constint.hpp.

## ConstIntView() [2/2]

Gecode::Int::ConstIntView::ConstIntView | ( | int | n | ) |

inline

Initialize with integer value n.

Definition at line 43 of file constint.hpp.

## Member Function Documentation

## min() [1/2]

int Gecode::Int::ConstIntView::min | ( | void |  | ) | const

inline

Return minimum of domain.

Definition at line 50 of file constint.hpp.

## max() [1/2]

int Gecode::Int::ConstIntView::max | ( | void |  | ) | const

inline

Return maximum of domain.

Definition at line 54 of file constint.hpp.

## med()

int Gecode::Int::ConstIntView::med | ( | void |  | ) | const

inline

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

Definition at line 58 of file constint.hpp.

## val()

int Gecode::Int::ConstIntView::val | ( | void |  | ) | const

inline

Return assigned value (only if assigned).

Definition at line 62 of file constint.hpp.

## size()

unsigned int Gecode::Int::ConstIntView::size | ( | void |  | ) | const

inline

Return size (cardinality) of domain.

Definition at line 67 of file constint.hpp.

## width() [1/2]

unsigned int Gecode::Int::ConstIntView::width | ( | void |  | ) | const

inline

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

Definition at line 71 of file constint.hpp.

## regret_min()

unsigned int Gecode::Int::ConstIntView::regret_min | ( | void |  | ) | const

inline

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

Definition at line 75 of file constint.hpp.

## regret_max()

unsigned int Gecode::Int::ConstIntView::regret_max | ( | void |  | ) | const

inline

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

Definition at line 79 of file constint.hpp.

## range()

bool Gecode::Int::ConstIntView::range | ( | void |  | ) | const

inline

Test whether domain is a range.

Definition at line 89 of file constint.hpp.

## in() [1/2]

bool Gecode::Int::ConstIntView::in | ( | int | n | ) | const

inline

Test whether n is contained in domain.

Definition at line 93 of file constint.hpp.

## in() [2/2]

bool Gecode::Int::ConstIntView::in | ( | long long int | n | ) | const

inline

Test whether n is contained in domain.

Definition at line 97 of file constint.hpp.

## lq() [1/2]

ModEvent Gecode::Int::ConstIntView::lq | ( | Space & | home,
|  | int | n )

inline

Restrict domain values to be less or equal than n.

Definition at line 107 of file constint.hpp.

## lq() [2/2]

ModEvent Gecode::Int::ConstIntView::lq | ( | Space & | home,
|  | long long int | n )

inline

Restrict domain values to be less or equal than n.

Definition at line 111 of file constint.hpp.

## le() [1/2]

ModEvent Gecode::Int::ConstIntView::le | ( | Space & | home,
|  | int | n )

inline

Restrict domain values to be less than n.

Definition at line 116 of file constint.hpp.

## le() [2/2]

ModEvent Gecode::Int::ConstIntView::le | ( | Space & | home,
|  | long long int | n )

inline

Restrict domain values to be less than n.

Definition at line 120 of file constint.hpp.

## gq() [1/2]

ModEvent Gecode::Int::ConstIntView::gq | ( | Space & | home,
|  | int | n )

inline

Restrict domain values to be greater or equal than n.

Definition at line 125 of file constint.hpp.

## gq() [2/2]

ModEvent Gecode::Int::ConstIntView::gq | ( | Space & | home,
|  | long long int | n )

inline

Restrict domain values to be greater or equal than n.

Definition at line 129 of file constint.hpp.

## gr() [1/2]

ModEvent Gecode::Int::ConstIntView::gr | ( | Space & | home,
|  | int | n )

inline

Restrict domain values to be greater than n.

Definition at line 134 of file constint.hpp.

## gr() [2/2]

ModEvent Gecode::Int::ConstIntView::gr | ( | Space & | home,
|  | long long int | n )

inline

Restrict domain values to be greater than n.

Definition at line 138 of file constint.hpp.

## nq() [1/2]

ModEvent Gecode::Int::ConstIntView::nq | ( | Space & | home,
|  | int | n )

inline

Restrict domain values to be different from n.

Definition at line 143 of file constint.hpp.

## nq() [2/2]

ModEvent Gecode::Int::ConstIntView::nq | ( | Space & | home,
|  | long long int | n )

inline

Restrict domain values to be different from n.

Definition at line 147 of file constint.hpp.

## eq() [1/2]

ModEvent Gecode::Int::ConstIntView::eq | ( | Space & | home,
|  | int | n )

inline

Restrict domain values to be equal to n.

Definition at line 152 of file constint.hpp.

## eq() [2/2]

ModEvent Gecode::Int::ConstIntView::eq | ( | Space & | home,
|  | long long int | n )

inline

Restrict domain values to be equal to n.

Definition at line 156 of file constint.hpp.

## narrow_r()

template<class I>

ModEvent Gecode::Int::ConstIntView::narrow_r | ( | Space & | home,
|  | I & | i,
|  | bool | depends = true )

inline

Replace domain by ranges described by i.

Definition at line 168 of file constint.hpp.

## inter_r()

template<class I>

ModEvent Gecode::Int::ConstIntView::inter_r | ( | Space & | home,
|  | I & | i,
|  | bool | depends = true )

inline

Intersect domain with ranges described by i.

Definition at line 173 of file constint.hpp.

## minus_r()

template<class I>

ModEvent Gecode::Int::ConstIntView::minus_r | ( | Space & | home,
|  | I & | i,
|  | bool | depends = true )

inline

Remove from domain the ranges described by i.

Definition at line 180 of file constint.hpp.

## narrow_v()

template<class I>

ModEvent Gecode::Int::ConstIntView::narrow_v | ( | Space & | home,
|  | I & | i,
|  | bool | depends = true )

inline

Replace domain by values described by i.

Definition at line 187 of file constint.hpp.

## inter_v()

template<class I>

ModEvent Gecode::Int::ConstIntView::inter_v | ( | Space & | home,
|  | I & | i,
|  | bool | depends = true )

inline

Intersect domain with values described by i.

Definition at line 192 of file constint.hpp.

## minus_v()

template<class I>

ModEvent Gecode::Int::ConstIntView::minus_v | ( | Space & | home,
|  | I & | i,
|  | bool | depends = true )

inline

Remove from domain the values described by i.

Definition at line 199 of file constint.hpp.

## min() [2/2]

int Gecode::Int::ConstIntView::min | ( | const Delta & | d | ) | const

inline

Return minimum value just pruned.

Definition at line 211 of file constint.hpp.

## max() [2/2]

int Gecode::Int::ConstIntView::max | ( | const Delta & | d | ) | const

inline

Return maximum value just pruned.

Definition at line 215 of file constint.hpp.

## width() [2/2]

unsigned int Gecode::Int::ConstIntView::width | ( | const Delta & | d | ) | const

inline

Return width of values just pruned.

Definition at line 219 of file constint.hpp.

## any()

bool Gecode::Int::ConstIntView::any | ( | const Delta & | d | ) | const

inline

Test whether arbitrary values got pruned.

Definition at line 223 of file constint.hpp.

## update()

void Gecode::Int::ConstIntView::update | ( | Space & | home,
|  | ConstIntView & | y )

inline

Update this view to be a clone of view y.

Definition at line 234 of file constint.hpp.

## operator<()

bool Gecode::Int::ConstIntView::operator< | ( | const ConstIntView & | y | ) | const

inline

Whether this view comes before view y (arbitray order).

Definition at line 244 of file constint.hpp.

## Friends And Related Symbol Documentation

## operator<<()

template<class Char, class Traits>

std::basic_ostream< Char, Traits > & operator<< | ( | std::basic_ostream< Char, Traits > & | os,
|  | const ConstIntView & | x )

related

Print integer constant integer view.

Definition at line 67 of file print.hpp.

## operator==()

bool operator== | ( | const ConstIntView & | x,
|  | const ConstIntView & | y )

related

Test whether views x and y are the same.

Definition at line 323 of file constint.hpp.

## operator!=()

bool operator!= | ( | const ConstIntView & | x,
|  | const ConstIntView & | y )

related

Test whether views x and y are not the same.

Definition at line 327 of file constint.hpp.

## Member Data Documentation

## x

int Gecode::Int::ConstIntView::x

protected

Definition at line 853 of file view.hpp.

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

- gecode/int/view.hpp
- gecode/int/view/constint.hpp