Generated on Sat May 25 2013 18:00:45 for Gecode by doxygen 1.8.3.1
Gecode::ValCommitFunction< View > Class Template Reference

Class for user-defined value commit. More...

#include <brancher-val-commit.hpp>

Public Types

typedef View::VarType Var
 The corresponding variable type. More...
 
typedef BranchTraits< Var >::Commit CommitFunction
 The corresponding commit function. More...
 
- Public Types inherited from Gecode::ValCommit< View, BranchTraits< View::VarType >::ValType >
typedef View View
 View type. More...
 
typedef BranchTraits
< View::VarType >::ValType 
Val
 Value type. More...
 

Public Member Functions

 ValCommitFunction (Space &home, const ValBranch &vb)
 Constructor for initialization. More...
 
 ValCommitFunction (Space &home, bool shared, ValCommitFunction &vc)
 Constructor for cloning during copying. More...
 
ModEvent commit (Space &home, unsigned int a, View x, int i, Val n)
 Perform user-defined commit. More...
 
- Public Member Functions inherited from Gecode::ValCommit< View, BranchTraits< View::VarType >::ValType >
 ValCommit (Space &home, const ValBranch &vb)
 Constructor for initialization. More...
 
 ValCommit (Space &home, bool shared, ValCommit< View, Val > &vs)
 Constructor for cloning. More...
 
bool notice (void) const
 Whether dispose must always be called (that is, notice is needed) More...
 
void dispose (Space &home)
 Delete value commit. More...
 

Protected Attributes

CommitFunction c
 The user-defined commit function. More...
 

Detailed Description

template<class View>
class Gecode::ValCommitFunction< View >

Class for user-defined value commit.

Definition at line 67 of file brancher-val-commit.hpp.

Member Typedef Documentation

template<class View>
typedef View::VarType Gecode::ValCommitFunction< View >::Var

The corresponding variable type.

Definition at line 75 of file brancher-val-commit.hpp.

template<class View>
typedef BranchTraits<Var>::Commit Gecode::ValCommitFunction< View >::CommitFunction

The corresponding commit function.

Definition at line 77 of file brancher-val-commit.hpp.

Constructor & Destructor Documentation

template<class View >
Gecode::ValCommitFunction< View >::ValCommitFunction ( Space home,
const ValBranch vb 
)
inline

Constructor for initialization.

Definition at line 111 of file brancher-val-commit.hpp.

template<class View >
Gecode::ValCommitFunction< View >::ValCommitFunction ( Space home,
bool  shared,
ValCommitFunction< View > &  vc 
)
inline

Constructor for cloning during copying.

Definition at line 117 of file brancher-val-commit.hpp.

Member Function Documentation

template<class View >
ModEvent Gecode::ValCommitFunction< View >::commit ( Space home,
unsigned int  a,
View  x,
int  i,
Val  n 
)
inline

Perform user-defined commit.

Definition at line 122 of file brancher-val-commit.hpp.

Member Data Documentation

template<class View>
CommitFunction Gecode::ValCommitFunction< View >::c
protected

The user-defined commit function.

Definition at line 80 of file brancher-val-commit.hpp.


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