Generated on Tue Jul 27 2010 21:59:26 for Gecode by doxygen 1.7.1

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

Base-class for variables. More...

#include <var.hpp>

List of all members.

Protected Member Functions

 Var (void)
 Default constructor.
 Var (VarImp *y)
 Initialize with variable implementation y.

Protected Attributes

VarImpx
 Pointer to variable implementation.

Generic variable information



VarImpvarimp (void) const
 Return variable implementation of variable.
unsigned int degree (void) const
 Return degree (number of subscribed propagators and advisors).
double afc (void) const
 Return accumulated failure count (plus degree).

Domain tests



bool assigned (void) const
 Test whether view is assigned.

Cloning



void update (Space &home, bool share, Var< VarImp > &y)
 Update this variable to be a clone of variable y.

Variable comparison



bool same (const Var< VarImp > &y) const
 Test whether variable is the same as y.
bool before (const Var< VarImp > &y) const
 Test whether variable comes before y (arbitrary order).

Detailed Description

template<class VarImp>
class Gecode::Var< VarImp >

Base-class for variables.

Definition at line 45 of file var.hpp.


Constructor & Destructor Documentation

template<class VarImp >
Gecode::Var< VarImp >::Var ( void   )  [inline, protected]

Default constructor.

Definition at line 92 of file var.hpp.

template<class VarImp>
Gecode::Var< VarImp >::Var ( VarImp y  )  [inline, protected]

Initialize with variable implementation y.

Definition at line 96 of file var.hpp.


Member Function Documentation

template<class VarImp >
VarImp * Gecode::Var< VarImp >::varimp ( void   )  const [inline]

Return variable implementation of variable.

Definition at line 100 of file var.hpp.

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

Return degree (number of subscribed propagators and advisors).

Definition at line 105 of file var.hpp.

template<class VarImp >
double Gecode::Var< VarImp >::afc ( void   )  const [inline]

Return accumulated failure count (plus degree).

Definition at line 110 of file var.hpp.

template<class VarImp >
bool Gecode::Var< VarImp >::assigned ( void   )  const [inline]

Test whether view is assigned.

Definition at line 115 of file var.hpp.

template<class VarImp>
void Gecode::Var< VarImp >::update ( Space home,
bool  share,
Var< VarImp > &  y 
) [inline]

Update this variable to be a clone of variable y.

Definition at line 120 of file var.hpp.

template<class VarImp>
bool Gecode::Var< VarImp >::same ( const Var< VarImp > &  y  )  const [inline]

Test whether variable is the same as y.

Definition at line 125 of file var.hpp.

template<class VarImp>
bool Gecode::Var< VarImp >::before ( const Var< VarImp > &  y  )  const [inline]

Test whether variable comes before y (arbitrary order).

Definition at line 130 of file var.hpp.


Member Data Documentation

template<class VarImp>
VarImp* Gecode::Var< VarImp >::x [protected]

Pointer to variable implementation.

Definition at line 48 of file var.hpp.


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