Generated on Wed Mar 19 07:30:08 2008 for Gecode by doxygen 1.5.5

Gecode::VarBase< VarImp > Class Template Reference
[Programming views for variables]

Inherited by Gecode::BoolVar, Gecode::CpltSetVar, Gecode::IntVar, and Gecode::SetVar.

List of all members.


Detailed Description

template<class VarImp>
class Gecode::VarBase< VarImp >

Base-class for variables.

Definition at line 45 of file var.icc.


Generic variable information

VarImp * var (void) const
 Return variable implementation of variable.
unsigned int degree (void) const
 Return degree (number of subscribed propagators and advisors).

Variable comparison

template<class VarImp>
bool same (const VarBase< VarImp > &x, const VarBase< VarImp > &y)
 Test whether views x and y are the same.
template<class VarImp>
bool before (const VarBase< VarImp > &x, const VarBase< VarImp > &y)
 Test whether view x comes before y (arbitrary order).

Protected Member Functions

 VarBase (void)
 Default constructor.
 VarBase (VarImp *x)
 Initialize with variable implementation x.
 VarBase (const Reflection::Var &x)
 Initialize with reflection variable x.

Protected Attributes

VarImp * varimp
 Pointer to variable implementation.

Constructor & Destructor Documentation

template<class VarImp>
Gecode::VarBase< VarImp >::VarBase ( void   )  [protected]

Default constructor.

template<class VarImp>
Gecode::VarBase< VarImp >::VarBase ( VarImp *  x  )  [inline, protected]

Initialize with variable implementation x.

Definition at line 89 of file var.icc.

template<class VarImp>
Gecode::VarBase< VarImp >::VarBase ( const Reflection::Var &  x  )  [inline, protected]

Initialize with reflection variable x.

Definition at line 93 of file var.icc.


Member Function Documentation

template<class VarImp>
VarImp * Gecode::VarBase< VarImp >::var ( void   )  const [inline]

Return variable implementation of variable.

Definition at line 97 of file var.icc.

template<class VarImp>
unsigned int Gecode::VarBase< VarImp >::degree ( void   )  const [inline]

Return degree (number of subscribed propagators and advisors).

Definition at line 102 of file var.icc.


Friends And Related Function Documentation

template<class VarImp>
bool same ( const VarBase< VarImp > &  x,
const VarBase< VarImp > &  y 
) [related]

Test whether views x and y are the same.

Definition at line 109 of file var.icc.

template<class VarImp>
bool before ( const VarBase< VarImp > &  x,
const VarBase< VarImp > &  y 
) [related]

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

Definition at line 114 of file var.icc.


Member Data Documentation

template<class VarImp>
VarImp* Gecode::VarBase< VarImp >::varimp [protected]

Pointer to variable implementation.

Definition at line 48 of file var.icc.


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