Generated on Mon Aug 25 11:35:49 2008 for Gecode by doxygen 1.5.6

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

VarImpvar (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.

Protected Attributes

VarImpvarimp
 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 87 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 91 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 96 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 103 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 108 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: