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

Base-class for variable implementation views. More...

#include <view.hpp>

List of all members.

Public Types
typedef Var	VarType
	The variable type corresponding to the view.
typedef Var::VarImpType	VarImpType
	The variable implementation type corresponding to the view.
Protected Member Functions
	VarImpView (void)
	Default constructor.
	VarImpView (VarImpType *y)
	Initialize with variable implementation y.
void	varimp (VarImpType *y)
	Set variable implementation to y.
Protected Attributes
VarImpType *	x
	Pointer to variable implementation.
Generic view information
static bool	varderived (void)
	Return whether this view is derived from a VarImpView.
VarImpType *	varimp (void) const
	Return variable implementation of view.
unsigned int	degree (void) const
	Return degree (number of subscribed propagators and advisors).
double	afc (void) const
	Return accumulated failure count.
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.
Delta information for advisors
static ModEvent	modevent (const Delta &d)
	Return modification event.
Domain tests
bool	assigned (void) const
	Test whether view is assigned.
Dependencies
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	subscribe (Space &home, Advisor &a, bool fail=false)
	Subscribe advisor a to view.
void	cancel (Space &home, Advisor &a, bool fail=false)
	Cancel subscription of advisor a.
Cloning
void	update (Space &home, VarImpView< Var > &y)
	Update this view to be a clone of view y.
View comparison
template<class VarA , class VarB >
bool	same (const VarImpView< VarA > &x, const VarImpView< VarB > &y)
	Test whether views x and y are the same.
template<class ViewA , class ViewB >
bool	before (const ViewA &x, const ViewB &y)
	Test whether view x comes before y (arbitrary order).

---

Detailed Description

template<class Var>
class Gecode::VarImpView< Var >

Base-class for variable implementation views.

Definition at line 127 of file view.hpp.

---

Member Typedef Documentation

template<class Var>

typedef Var Gecode::VarImpView< Var >::VarType

The variable type corresponding to the view.

Definition at line 130 of file view.hpp.

template<class Var>

typedef Var::VarImpType Gecode::VarImpView< Var >::VarImpType

The variable implementation type corresponding to the view.

Definition at line 132 of file view.hpp.

---

Constructor & Destructor Documentation

template<class Var >

Gecode::VarImpView< Var >::VarImpView

(

void

)

[inline, protected]

Default constructor.

Definition at line 464 of file view.hpp.

template<class Var >

Gecode::VarImpView< Var >::VarImpView

(

VarImpType *

y

)

[inline, protected]

Initialize with variable implementation y.

Definition at line 468 of file view.hpp.

---

Member Function Documentation

template<class Var >

void Gecode::VarImpView< Var >::varimp

(

VarImpType *

y

)

[inline, protected]

Set variable implementation to y.

Definition at line 472 of file view.hpp.

template<class Var >

bool Gecode::VarImpView< Var >::varderived

(

void

)

[inline, static]

Return whether this view is derived from a VarImpView.

Definition at line 477 of file view.hpp.

template<class Var >

Var::VarImpType * Gecode::VarImpView< Var >::varimp

(

void

)

const [inline]

Return variable implementation of view.

Definition at line 482 of file view.hpp.

template<class Var >

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

(

void

)

const [inline]

Return degree (number of subscribed propagators and advisors).

Definition at line 487 of file view.hpp.

template<class Var >

double Gecode::VarImpView< Var >::afc

(

void

)

const [inline]

Return accumulated failure count.

Definition at line 492 of file view.hpp.

template<class Var >

bool Gecode::VarImpView< Var >::assigned

(

void

)

const [inline]

Test whether view is assigned.

Definition at line 504 of file view.hpp.

template<class Var >

void Gecode::VarImpView< Var >::schedule	(	Space &	home,
		Propagator &	p,
		ModEvent	me
	)			[inline, static]

Schedule propagator p with modification event me.

Definition at line 535 of file view.hpp.

template<class Var >

ModEvent Gecode::VarImpView< Var >::me

(

const ModEventDelta &

med

)

[inline, static]

Return modification event for view type in med.

Definition at line 540 of file view.hpp.

template<class Var >

ModEventDelta Gecode::VarImpView< Var >::med

(

ModEvent

me

)

[inline, static]

Translate modification event me to modification event delta for view.

Reimplemented in Gecode::Float::FloatView, Gecode::Int::IntView, and Gecode::Int::BoolView.

Definition at line 545 of file view.hpp.

template<class Var >

void Gecode::VarImpView< Var >::subscribe	(	Space &	home,
		Propagator &	p,
		PropCond	pc,
		bool	schedule = true
	)			[inline]

Subscribe propagator p with propagation condition pc to view.

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

Definition at line 509 of file view.hpp.

template<class Var >

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

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

Definition at line 515 of file view.hpp.

template<class Var >

void Gecode::VarImpView< Var >::reschedule	(	Space &	home,
		Propagator &	p,
		PropCond	pc
	)			[inline]

Re-schedule propagator p with propagation condition pc.

Definition at line 520 of file view.hpp.

template<class Var >

void Gecode::VarImpView< Var >::subscribe	(	Space &	home,
		Advisor &	a,
		bool	fail = false
	)			[inline]

Subscribe advisor a to view.

If fail is true, run the advisor also on failure. This feature is undocumented.

Definition at line 525 of file view.hpp.

template<class Var >

void Gecode::VarImpView< Var >::cancel	(	Space &	home,
		Advisor &	a,
		bool	fail = false
	)			[inline]

Cancel subscription of advisor a.

Definition at line 530 of file view.hpp.

template<class Var >

ModEvent Gecode::VarImpView< Var >::modevent

(

const Delta &

d

)

[inline, static]

Return modification event.

Reimplemented in Gecode::Set::SetView.

Definition at line 550 of file view.hpp.

template<class Var>

void Gecode::VarImpView< Var >::update	(	Space &	home,
		VarImpView< Var > &	y
	)			[inline]

Update this view to be a clone of view y.

Definition at line 555 of file view.hpp.

---

Friends And Related Function Documentation

template<class VarA , class VarB >

bool same	(	const VarImpView< VarA > &	x,
		const VarImpView< VarB > &	y
	)			[related]

Test whether views x and y are the same.

template<class ViewA , class ViewB >

bool before	(	const ViewA &	x,
		const ViewB &	y
	)			[related]

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

Definition at line 723 of file view.hpp.

---

Member Data Documentation

template<class Var>

VarImpType* Gecode::VarImpView< Var >::x [protected]

Pointer to variable implementation.

Definition at line 135 of file view.hpp.

---

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

• gecode/kernel/view.hpp