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

#include <view.hpp>

Protected Attributes
int	c
	Offset.
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 OffsetView &x)
	Print integer offset view.
Constructors and initialization

	OffsetView (void)
	Default constructor.
	OffsetView (const IntView &y, int c)
	Initialize with integer view y and offset c.
Value access

int	offset (void) const
	Return offset.
void	offset (int n)
	Change offset to n.
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.
Cloning

void	update (Space &home, bool share, OffsetView &y)
	Update this view to be a clone of view y.
View-dependent propagator support

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

bool	same (const OffsetView &x, const OffsetView &y)
	Test whether views x and y are the same.
bool	before (const OffsetView &x, const OffsetView &y)
	Test whether view x comes before y (arbitrary order).

Detailed Description

Offset integer view.

An offset integer view $o$ for an integer view $x$ and an integer $c$ provides operations such that $o$ behaves as $x+c$ .

Definition at line 422 of file view.hpp.

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 45 of file offset.hpp.

Gecode::Int::OffsetView::OffsetView	(	const IntView &	y,
		int	c
	)			`[inline]`

Initialize with integer view y and offset c.

Definition at line 47 of file offset.hpp.

Member Function Documentation

int Gecode::Int::OffsetView::offset ( void ) const [inline]

Return offset.

Definition at line 56 of file offset.hpp.

void Gecode::Int::OffsetView::offset ( int n ) [inline]

Change offset to n.

Definition at line 60 of file offset.hpp.

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

Return minimum of domain.

Definition at line 64 of file offset.hpp.

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

Return maximum of domain.

Definition at line 68 of file offset.hpp.

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

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

Definition at line 72 of file offset.hpp.

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

Return assigned value (only if assigned).

Definition at line 76 of file offset.hpp.

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

Return size (cardinality) of domain.

Definition at line 85 of file offset.hpp.

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

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

Definition at line 81 of file offset.hpp.

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

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

Definition at line 89 of file offset.hpp.

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

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

Definition at line 93 of file offset.hpp.

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

Test whether domain is a range.

Definition at line 102 of file offset.hpp.

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

Test whether n is contained in domain.

Definition at line 106 of file offset.hpp.

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

Test whether n is contained in domain.

Definition at line 110 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::lq	(	Space &	home,
		int	n
	)			`[inline]`

Restrict domain values to be less or equal than n.

Definition at line 120 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::lq	(	Space &	home,
		double	n
	)			`[inline]`

Restrict domain values to be less or equal than n.

Definition at line 124 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::le	(	Space &	home,
		int	n
	)			`[inline]`

Restrict domain values to be less than n.

Definition at line 128 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::le	(	Space &	home,
		double	n
	)			`[inline]`

Restrict domain values to be less than n.

Definition at line 132 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::gq	(	Space &	home,
		int	n
	)			`[inline]`

Restrict domain values to be greater or equal than n.

Definition at line 136 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::gq	(	Space &	home,
		double	n
	)			`[inline]`

Restrict domain values to be greater or equal than n.

Definition at line 140 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::gr	(	Space &	home,
		int	n
	)			`[inline]`

Restrict domain values to be greater than n.

Definition at line 144 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::gr	(	Space &	home,
		double	n
	)			`[inline]`

Restrict domain values to be greater than n.

Definition at line 148 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::nq	(	Space &	home,
		int	n
	)			`[inline]`

Restrict domain values to be different from n.

Definition at line 152 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::nq	(	Space &	home,
		double	n
	)			`[inline]`

Restrict domain values to be different from n.

Definition at line 156 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::eq	(	Space &	home,
		int	n
	)			`[inline]`

Restrict domain values to be equal to n.

Definition at line 160 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::eq	(	Space &	home,
		double	n
	)			`[inline]`

Restrict domain values to be equal to n.

Definition at line 164 of file offset.hpp.

template<class I >

ModEvent Gecode::Int::OffsetView::narrow_r	(	Space &	home,
		I &	i,
		bool	depends = `true`
	)			`[inline]`

Replace domain by ranges described by i.

Definition at line 175 of file offset.hpp.

template<class I >

ModEvent Gecode::Int::OffsetView::inter_r	(	Space &	home,
		I &	i,
		bool	depends = `true`
	)			`[inline]`

Intersect domain with ranges described by i.

Definition at line 181 of file offset.hpp.

template<class I >

ModEvent Gecode::Int::OffsetView::minus_r	(	Space &	home,
		I &	i,
		bool	depends = `true`
	)			`[inline]`

Remove from domain the ranges described by i.

Definition at line 187 of file offset.hpp.

template<class I >

ModEvent Gecode::Int::OffsetView::narrow_v	(	Space &	home,
		I &	i,
		bool	depends = `true`
	)			`[inline]`

Replace domain by values described by i.

Definition at line 193 of file offset.hpp.

template<class I >

ModEvent Gecode::Int::OffsetView::inter_v	(	Space &	home,
		I &	i,
		bool	depends = `true`
	)			`[inline]`

Intersect domain with values described by i.

Definition at line 199 of file offset.hpp.

template<class I >

ModEvent Gecode::Int::OffsetView::minus_v	(	Space &	home,
		I &	i,
		bool	depends = `true`
	)			`[inline]`

Remove from domain the values described by i.

Definition at line 205 of file offset.hpp.

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

Translate modification event me to modification event delta for view.

Reimplemented from Gecode::DerivedView< IntView >.

Definition at line 217 of file offset.hpp.

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

Return minimum value just pruned.

Definition at line 227 of file offset.hpp.

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

Return maximum value just pruned.

Definition at line 231 of file offset.hpp.

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

Test whether arbitrary values got pruned.

Definition at line 235 of file offset.hpp.

void Gecode::Int::OffsetView::update	(	Space &	home,
		bool	share,
		OffsetView &	y
	)			`[inline]`

Update this view to be a clone of view y.

Definition at line 246 of file offset.hpp.

Friends And Related Function Documentation

template<class Char , class Traits >

std::basic_ostream< Char, Traits > & operator<<	(	std::basic_ostream< Char, Traits > &	os,
		const OffsetView &	x
	)			`[related]`

Print integer offset view.

Definition at line 107 of file print.hpp.

bool same	(	const OffsetView &	x,
		const OffsetView &	y
	)			`[related]`

Test whether views x and y are the same.

Definition at line 291 of file offset.hpp.

bool before	(	const OffsetView &	x,
		const OffsetView &	y
	)			`[related]`

Test whether view x comes before y (arbitrary order).

Definition at line 295 of file offset.hpp.

Member Data Documentation

int Gecode::Int::OffsetView::c [protected]

Offset.

Definition at line 425 of file view.hpp.

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

gecode/int/view.hpp (Revision: 12418)
gecode/int/view/offset.hpp (Revision: 11464)

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

Protected Attributes

Related Functions

Constructors and initialization

Value access

Domain tests

Domain update by value

Domain update by iterator

Delta information for advisors

Cloning

View-dependent propagator support

View comparison

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

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