Generated on Thu Mar 22 10:39:53 2012 for Gecode by doxygen 1.6.3

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

Variables as interfaces to variable implementations. More...

#include <var.hpp>

List of all members.

Public Types

typedef VarImp VarImpType
 The variable implementation type corresponding to the variable.

Protected Member Functions

 VarImpVar (void)
 Default constructor.
 VarImpVar (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, VarImpVar< VarImp > &y)
 Update this variable to be a clone of variable y.

Variable comparison



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

Detailed Description

template<class VarImp>
class Gecode::VarImpVar< VarImp >

Variables as interfaces to variable implementations.

Definition at line 51 of file var.hpp.


Member Typedef Documentation

template<class VarImp>
typedef VarImp Gecode::VarImpVar< VarImp >::VarImpType

The variable implementation type corresponding to the variable.

Definition at line 61 of file var.hpp.


Constructor & Destructor Documentation

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

Default constructor.

Definition at line 100 of file var.hpp.

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

Initialize with variable implementation y.

Definition at line 104 of file var.hpp.


Member Function Documentation

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

Return variable implementation of variable.

Definition at line 108 of file var.hpp.

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

Return degree (number of subscribed propagators and advisors).

Definition at line 113 of file var.hpp.

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

Return accumulated failure count (plus degree).

Definition at line 118 of file var.hpp.

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

Test whether view is assigned.

Definition at line 123 of file var.hpp.

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

Update this variable to be a clone of variable y.

Definition at line 128 of file var.hpp.

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

Test whether variable is the same as y.

Definition at line 133 of file var.hpp.

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

Test whether variable comes before y (arbitrary order).

Definition at line 138 of file var.hpp.


Member Data Documentation

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

Pointer to variable implementation.

Definition at line 54 of file var.hpp.


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