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

Minus integer view. 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 MinusView &x)
| Print integer minus view.

## Constructors and initialization

| MinusView (void)
| Default constructor.
| MinusView (const IntView &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.
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.

## View comparison

bool | operator== (const MinusView &x, const MinusView &y)
| Test whether views x and y are the same.
bool | operator!= (const MinusView &x, const MinusView &y)
| Test whether views x and y are not the same.

## Additional Inherited Members

Public Types inherited from Gecode::DerivedView< IntView >
typedef IntView::VarImpType | VarImpType
| The variable implementation type belonging to the View.
typedef IntView::VarType | VarType
| The variable type belonging to the View.
VarImpType * | varimp (void) const
| Return variable implementation of view.
IntView | base (void) const
| Return view from which this view is derived.
unsigned int | degree (void) const
| Return degree (number of subscribed propagators).
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, DerivedView< IntView > &y)
| Update this view to be a clone of view y.
bool | operator< (const DerivedView< IntView > &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)
| 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::DerivedView< IntView >
| DerivedView (void)
| Default constructor.
Protected Attributes inherited from Gecode::DerivedView< IntView >
IntView | x
| View from which this view is derived.

## Detailed Description

Minus integer view.

A minus integer view for an integer view provides operations such that behaves as .

Definition at line 282 of file view.hpp.

## Constructor & Destructor Documentation

## MinusView() [1/2]

Gecode::Int::MinusView::MinusView | ( | void |  | ) |

inline

Default constructor.

Definition at line 45 of file minus.hpp.

## MinusView() [2/2]

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

inline explicit

Initialize with integer view y.

Definition at line 47 of file minus.hpp.

## Member Function Documentation

## min() [1/2]

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

inline

Return minimum of domain.

Definition at line 56 of file minus.hpp.

## max() [1/2]

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

inline

Return maximum of domain.

Definition at line 60 of file minus.hpp.

## med() [1/2]

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

inline

Return median of domain.

Definition at line 297 of file minus.hpp.

## val()

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

inline

Return assigned value (only if assigned).

Definition at line 64 of file minus.hpp.

## size()

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

inline

Return size (cardinality) of domain.

Definition at line 79 of file minus.hpp.

## width() [1/2]

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

inline

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

Definition at line 75 of file minus.hpp.

## regret_min()

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

inline

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

Definition at line 83 of file minus.hpp.

## regret_max()

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

inline

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

Definition at line 87 of file minus.hpp.

## range()

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

inline

Test whether domain is a range.

Definition at line 97 of file minus.hpp.

## in() [1/2]

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

inline

Test whether n is contained in domain.

Definition at line 101 of file minus.hpp.

## in() [2/2]

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

inline

Test whether n is contained in domain.

Definition at line 105 of file minus.hpp.

## lq() [1/2]

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

inline

Restrict domain values to be less or equal than n.

Definition at line 115 of file minus.hpp.

## lq() [2/2]

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

inline

Restrict domain values to be less or equal than n.

Definition at line 119 of file minus.hpp.

## le() [1/2]

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

inline

Restrict domain values to be less than n.

Definition at line 124 of file minus.hpp.

## le() [2/2]

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

inline

Restrict domain values to be less than n.

Definition at line 128 of file minus.hpp.

## gq() [1/2]

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

inline

Restrict domain values to be greater or equal than n.

Definition at line 133 of file minus.hpp.

## gq() [2/2]

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

inline

Restrict domain values to be greater or equal than n.

Definition at line 137 of file minus.hpp.

## gr() [1/2]

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

inline

Restrict domain values to be greater than n.

Definition at line 142 of file minus.hpp.

## gr() [2/2]

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

inline

Restrict domain values to be greater than n.

Definition at line 146 of file minus.hpp.

## nq() [1/2]

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

inline

Restrict domain values to be different from n.

Definition at line 151 of file minus.hpp.

## nq() [2/2]

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

inline

Restrict domain values to be different from n.

Definition at line 155 of file minus.hpp.

## eq() [1/2]

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

inline

Restrict domain values to be equal to n.

Definition at line 160 of file minus.hpp.

## eq() [2/2]

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

inline

Restrict domain values to be equal to n.

Definition at line 164 of file minus.hpp.

## narrow_r()

template<class I>

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

inline

Replace domain by ranges described by i.

Definition at line 175 of file minus.hpp.

## inter_r()

template<class I>

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

inline

Intersect domain with ranges described by i.

Definition at line 182 of file minus.hpp.

## minus_r()

template<class I>

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

inline

Remove from domain the ranges described by i.

Definition at line 189 of file minus.hpp.

## narrow_v()

template<class I>

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

inline

Replace domain by values described by i.

Definition at line 196 of file minus.hpp.

## inter_v()

template<class I>

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

inline

Intersect domain with values described by i.

Definition at line 203 of file minus.hpp.

## minus_v()

template<class I>

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

inline

Remove from domain the values described by i.

Definition at line 210 of file minus.hpp.

## med() [2/2]

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

inline static

Translate modification event me to modification event delta for view.

Definition at line 222 of file minus.hpp.

## min() [2/2]

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

inline

Return minimum value just pruned.

Definition at line 232 of file minus.hpp.

## max() [2/2]

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

inline

Return maximum value just pruned.

Definition at line 236 of file minus.hpp.

## width() [2/2]

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

inline

Return width of values just pruned.

Definition at line 240 of file minus.hpp.

## any()

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

inline

Test whether arbitrary values got pruned.

Definition at line 244 of file minus.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 MinusView & | x )

related

Print integer minus view.

Definition at line 67 of file print.hpp.

## operator==()

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

related

Test whether views x and y are the same.

Definition at line 317 of file minus.hpp.

## operator!=()

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

related

Test whether views x and y are not the same.

Definition at line 321 of file minus.hpp.

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

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