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

Offset integer view. More...

#include <view.hpp>

List of all members.

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 &x, int c)

Initialize with integer view x and offset c.

void init (const IntView &x, int c)

Initialize with integer view x and offset c.

int offset (void) const

Return offset.

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 assigned (void) const

Test whether view is assigned.

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.

Dependencies

void subscribe (Space &home, Propagator &p, PropCond pc, bool process=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 subscribe (Space &home, Advisor &a)

Subscribe advisor a to view.

void cancel (Space &home, Advisor &a)

Cancel subscription of advisor a.

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.

static ModEvent modevent (const Delta &d)

Return modification event.

Cloning

void update (Space &home, bool share, OffsetView &x)

Update this view to be a clone of view x.

View-dependent propagator support

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.

View comparison

bool same (const Int::OffsetView &x, const Int::OffsetView &y)

Test whether views x and y are the same.

bool before (const Int::OffsetView &x, const Int::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 523 of file view.hpp.

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 47 of file offset.hpp.

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

Initialize with integer view x and offset c.

Definition at line 49 of file offset.hpp.

Member Function Documentation

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

Initialize with integer view x and offset c.

Definition at line 52 of file offset.hpp.

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

Return offset.

Definition at line 56 of file offset.hpp.

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

Return minimum of domain.

Definition at line 66 of file offset.hpp.

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

Return maximum of domain.

Definition at line 70 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 74 of file offset.hpp.

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

Return assigned value (only if assigned).

Definition at line 78 of file offset.hpp.

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

Return size (cardinality) of domain.

Definition at line 87 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 83 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 91 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 95 of file offset.hpp.

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

Test whether domain is a range.

Definition at line 104 of file offset.hpp.

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

Test whether view is assigned.

Definition at line 108 of file offset.hpp.

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

Test whether n is contained in domain.

Definition at line 113 of file offset.hpp.

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

Test whether n is contained in domain.

Definition at line 117 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 127 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 131 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 135 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 139 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 143 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 147 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 151 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 155 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 159 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 163 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 167 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 171 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 182 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 188 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 194 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 200 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 206 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 212 of file offset.hpp.

void Gecode::Int::OffsetView::schedule	(	Space &	home,
		Propagator &	p,
		ModEvent	me
	)			`[inline, static]`

Schedule propagator p with modification event me.

Definition at line 224 of file offset.hpp.

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

Return modification event for view type in med.

Definition at line 228 of file offset.hpp.

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

Translate modification event me to modification event delta for view.

Definition at line 232 of file offset.hpp.

void Gecode::Int::OffsetView::subscribe	(	Space &	home,
		Propagator &	p,
		PropCond	pc,
		bool	process = `true`
	)			`[inline]`

Subscribe propagator p with propagation condition pc to view.

In case process is false, the propagator is just subscribed but not processed for execution (this must be used when creating subscriptions during propagation).

Definition at line 242 of file offset.hpp.

void Gecode::Int::OffsetView::cancel	(	Space &	home,
		Propagator &	p,
		PropCond	pc
	)			`[inline]`

Cancel subscription of propagator p with propagation condition pc to view.

Definition at line 247 of file offset.hpp.

void Gecode::Int::OffsetView::subscribe	(	Space &	home,
		Advisor &	a
	)			`[inline]`

Subscribe advisor a to view.

Definition at line 251 of file offset.hpp.

void Gecode::Int::OffsetView::cancel	(	Space &	home,
		Advisor &	a
	)			`[inline]`

Cancel subscription of advisor a.

Definition at line 255 of file offset.hpp.

ModEvent Gecode::Int::OffsetView::modevent ( const Delta & d ) [inline, static]

Return modification event.

Definition at line 265 of file offset.hpp.

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

Return minimum value just pruned.

Definition at line 269 of file offset.hpp.

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

Return maximum value just pruned.

Definition at line 273 of file offset.hpp.

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

Test whether arbitrary values got pruned.

Definition at line 277 of file offset.hpp.

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

Update this view to be a clone of view x.

Definition at line 288 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 Int::OffsetView &	x,
		const Int::OffsetView &	y
	)			`[related]`

Test whether views x and y are the same.

Definition at line 333 of file offset.hpp.

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

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

Definition at line 337 of file offset.hpp.

Member Data Documentation

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

Offset.

Definition at line 526 of file view.hpp.

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

gecode/int/view.hpp (Revision: 9020)
gecode/int/view/offset.hpp (Revision: 8155)


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 &x, int c)
	Initialize with integer view x and offset c.
void	init (const IntView &x, int c)
	Initialize with integer view x and offset c.
int	offset (void) const
	Return offset.
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	assigned (void) const
	Test whether view is assigned.
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.
Dependencies
void	subscribe (Space &home, Propagator &p, PropCond pc, bool process=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	subscribe (Space &home, Advisor &a)
	Subscribe advisor a to view.
void	cancel (Space &home, Advisor &a)
	Cancel subscription of advisor a.
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.
static ModEvent	modevent (const Delta &d)
	Return modification event.
Cloning
void	update (Space &home, bool share, OffsetView &x)
	Update this view to be a clone of view x.
View-dependent propagator support
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.
View comparison
bool	same (const Int::OffsetView &x, const Int::OffsetView &y)
	Test whether views x and y are the same.
bool	before (const Int::OffsetView &x, const Int::OffsetView &y)
	Test whether view x comes before y (arbitrary order).

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

Dependencies

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]