main page modules namespaces classes files
Gecode home

Gecode::VariableViewBase< Var > Class Template Reference
[Programming views for variables]

Inherited by Gecode::Int::IntView, and Gecode::Set::SetView.

List of all members.

---

Detailed Description

template<class Var>
class Gecode::VariableViewBase< Var >

Base-class for variable views.

Definition at line 55 of file view.icc.

Generic view information
Var *	variable (void) const
	Return variable implementation of view.
bool	modified (void) const
	Test whether view has been modified during propagation.
unsigned int	degree (void) const
	Return degree (number of subscribed propagators).
static bool	varderived (void)
	Return whether this view is derived from a VariableViewBase.
Dependencies
void	subscribe (Space *, Propagator *p, PropCond pc, bool process=true)
	Subscribe propagator p with propagation condition pc to variable.
void	cancel (Space *home, Propagator *p, PropCond pc)
	Cancel subscription of propagator p with propagation condition pc to view.
Propagator modification events
static ModEvent	pme (const Propagator *p)
	Return modification event of propagator p for view.
static PropModEvent	pme (ModEvent me)
	Translate modification event me to propagator modification event for view.
static ModEvent	combine (ModEvent me1, ModEvent me2)
	Combine modifications events me1 and me2.
View comparison
bool	same (const VariableViewBase< Var > &x, const VariableViewBase< Var > &y)
	Test whether views x and y are the same.
bool	before (const VariableViewBase< Var > &x, const VariableViewBase< Var > &y)
	Test whether view x comes before y (arbitrary order).
Protected Member Functions
	VariableViewBase (void)
	Default constructor.
	VariableViewBase (Var *x)
	Initialize with variable implementation x.
Protected Attributes
Var *	var
	Pointer to variable implementation.

---

Constructor & Destructor Documentation

template<class Var>

Gecode::VariableViewBase< Var >::VariableViewBase

(

void

)

[inline, protected]

Default constructor.

Definition at line 335 of file view.icc.

template<class Var>

Gecode::VariableViewBase< Var >::VariableViewBase

(

Var *

x

)

[inline, protected]

Initialize with variable implementation x.

Definition at line 338 of file view.icc.

---

Member Function Documentation

template<class Var>

bool Gecode::VariableViewBase< Var >::varderived

(

void

)

[inline, static]

Return whether this view is derived from a VariableViewBase.

Definition at line 342 of file view.icc.

template<class Var>

Var * Gecode::VariableViewBase< Var >::variable

(

void

)

const [inline]

Return variable implementation of view.

Definition at line 347 of file view.icc.

template<class Var>

bool Gecode::VariableViewBase< Var >::modified

(

void

)

const [inline]

Test whether view has been modified during propagation.

Definition at line 352 of file view.icc.

template<class Var>

unsigned int Gecode::VariableViewBase< Var >::degree

(

void

)

const [inline]

Return degree (number of subscribed propagators).

Definition at line 357 of file view.icc.

template<class Var>

ModEvent Gecode::VariableViewBase< Var >::pme

(

const Propagator *

p

)

[inline, static]

Return modification event of propagator p for view.

Definition at line 373 of file view.icc.

template<class Var>

PropModEvent Gecode::VariableViewBase< Var >::pme

(

ModEvent

me

)

[inline, static]

Translate modification event me to propagator modification event for view.

Definition at line 378 of file view.icc.

template<class Var>

ModEvent Gecode::VariableViewBase< Var >::combine	(	ModEvent	me1,
		ModEvent	me2
	)			[inline, static]

Combine modifications events me1 and me2.

Definition at line 383 of file view.icc.

template<class Var>

void Gecode::VariableViewBase< Var >::subscribe	(	Space *	,
		Propagator *	p,
		PropCond	pc,
		bool	process = true
	)			[inline]

Subscribe propagator p with propagation condition pc to variable.

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 362 of file view.icc.

template<class Var>

void Gecode::VariableViewBase< Var >::cancel	(	Space *	home,
		Propagator *	p,
		PropCond	pc
	)			[inline]

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

Definition at line 368 of file view.icc.

---

Friends And Related Function Documentation

template<class Var>

bool same	(	const VariableViewBase< Var > &	x,
		const VariableViewBase< Var > &	y
	)			[related]

Test whether views x and y are the same.

Definition at line 389 of file view.icc.

template<class Var>

bool before	(	const VariableViewBase< Var > &	x,
		const VariableViewBase< Var > &	y
	)			[related]

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

Definition at line 394 of file view.icc.

---

Member Data Documentation

template<class Var>

Var* Gecode::VariableViewBase< Var >::var [protected]

Pointer to variable implementation.

Definition at line 58 of file view.icc.

---

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

• gecode/kernel/view.icc (Revision: 3559)