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

Integer view for integer variables. More...

`#include <view.hpp>`

## Related Symbols

(Note that these are not member symbols.)
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 (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.

## View-dependent propagator support

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

## Additional Inherited Members

Public Types inherited from Gecode::VarImpView< IntVar >
typedef IntVar | VarType
| The variable type corresponding to the view.
typedef IntVar::VarImpType | VarImpType
| The variable implementation type corresponding to the view.
unsigned int | degree (void) const
| Return degree (number of subscribed propagators and advisors).
double | afc (void) const
| Return accumulated failure count.
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, VarImpView< IntVar > &y)
| Update this view to be a clone of view y.
bool | operator< (const VarImpView &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.
Protected Member Functions inherited from Gecode::VarImpView< IntVar >
| VarImpView (void)
| Default constructor.
void | varimp (VarImpType *y)
| Set variable implementation to y.
Protected Attributes inherited from Gecode::VarImpView< IntVar >
VarImpType * | x
| Pointer to variable implementation.

## Detailed Description

Integer view for integer variables.

Definition at line 129 of file view.hpp.

## Constructor & Destructor Documentation

## IntView() [1/3]

Gecode::Int::IntView::IntView | ( | void |  | ) |

inline

Default constructor.

Definition at line 45 of file int.hpp.

## IntView() [2/3]

Gecode::Int::IntView::IntView | ( | const IntVar & | y | ) |

inline

Initialize from integer variable y.

Definition at line 47 of file int.hpp.

## IntView() [3/3]

Gecode::Int::IntView::IntView | ( | IntVarImp * | y | ) |

inline

Initialize from integer variable y.

Definition at line 50 of file int.hpp.

## Member Function Documentation

## min() [1/2]

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

inline

Return minimum of domain.

Definition at line 58 of file int.hpp.

## max() [1/2]

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

inline

Return maximum of domain.

Definition at line 62 of file int.hpp.

## med() [1/2]

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.

## val()

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

inline

Return assigned value (only if assigned).

Definition at line 70 of file int.hpp.

## size()

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

inline

Return size (cardinality) of domain.

Definition at line 81 of file int.hpp.

## width() [1/2]

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

inline

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

Definition at line 85 of file int.hpp.

## regret_min()

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

inline

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

Definition at line 89 of file int.hpp.

## regret_max()

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

inline

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

Definition at line 93 of file int.hpp.

## range()

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

inline

Test whether domain is a range.

Definition at line 103 of file int.hpp.

## in() [1/2]

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

inline

Test whether n is contained in domain.

Definition at line 107 of file int.hpp.

## in() [2/2]

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

inline

Test whether n is contained in domain.

Definition at line 111 of file int.hpp.

## lq() [1/2]

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

inline

Restrict domain values to be less or equal than n.

Definition at line 121 of file int.hpp.

## lq() [2/2]

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

inline

Restrict domain values to be less or equal than n.

Definition at line 125 of file int.hpp.

## le() [1/2]

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

inline

Restrict domain values to be less than n.

Definition at line 130 of file int.hpp.

## le() [2/2]

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

inline

Restrict domain values to be less than n.

Definition at line 134 of file int.hpp.

## gq() [1/2]

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

inline

Restrict domain values to be greater or equal than n.

Definition at line 139 of file int.hpp.

## gq() [2/2]

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

inline

Restrict domain values to be greater or equal than n.

Definition at line 143 of file int.hpp.

## gr() [1/2]

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

inline

Restrict domain values to be greater than n.

Definition at line 148 of file int.hpp.

## gr() [2/2]

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

inline

Restrict domain values to be greater than n.

Definition at line 152 of file int.hpp.

## nq() [1/2]

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

inline

Restrict domain values to be different from n.

Definition at line 157 of file int.hpp.

## nq() [2/2]

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

inline

Restrict domain values to be different from n.

Definition at line 161 of file int.hpp.

## eq() [1/2]

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

inline

Restrict domain values to be equal to n.

Definition at line 166 of file int.hpp.

## eq() [2/2]

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

inline

Restrict domain values to be equal to n.

Definition at line 170 of file int.hpp.

## narrow_r()

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 181 of file int.hpp.

## inter_r()

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 186 of file int.hpp.

## minus_r()

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 191 of file int.hpp.

## narrow_v()

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 196 of file int.hpp.

## inter_v()

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 201 of file int.hpp.

## minus_v()

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 206 of file int.hpp.

## min() [2/2]

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

inline

Return minimum value just pruned.

Definition at line 218 of file int.hpp.

## max() [2/2]

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

inline

Return maximum value just pruned.

Definition at line 222 of file int.hpp.

## width() [2/2]

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

inline

Return width of values just pruned.

Definition at line 226 of file int.hpp.

## any()

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

inline

Test whether arbitrary values got pruned.

Definition at line 230 of file int.hpp.

## med() [2/2]

ModEventDelta Gecode::Int::IntView::med | ( | ModEvent | me | ) |

inline static

Translate modification event me to modification event delta for view.

Definition at line 236 of file int.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 IntView & | x )

related

Print integer variable view.

Definition at line 67 of file print.hpp.

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

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