Gecode::ValCommitFunction< View > Class Template Reference
[Generic value commit for brancher based on view and value selection]
Class for user-defined value commit. More...
#include <val-commit.hpp>
Public Types | |
typedef View::VarType | Var |
The corresponding variable type. | |
typedef BranchTraits< Var >::Commit | CommitFunction |
The corresponding commit function. | |
Public Member Functions | |
ValCommitFunction (Space &home, const ValBranch< Var > &vb) | |
Constructor for initialization. | |
ValCommitFunction (Space &home, ValCommitFunction &vc) | |
Constructor for cloning during copying. | |
ModEvent | commit (Space &home, unsigned int a, View x, int i, Val n) |
Perform user-defined commit. | |
NGL * | ngl (Space &home, unsigned int a, View x, Val n) const |
Create no-good literal for alternative a. | |
void | print (const Space &home, unsigned int a, View x, int i, const Val &n, std::ostream &o) const |
Print on o the alternative with view x at position i and value n. | |
bool | notice (void) const |
Whether dispose must always be called (that is, notice is needed). | |
void | dispose (Space &home) |
Delete value commit. | |
Protected Attributes | |
SharedData< CommitFunction > | c |
The user-defined commit function. |
Detailed Description
template<class View>
class Gecode::ValCommitFunction< View >
Class for user-defined value commit.
Definition at line 65 of file val-commit.hpp.
Member Typedef Documentation
typedef View::VarType Gecode::ValCommitFunction< View >::Var |
The corresponding variable type.
Reimplemented from Gecode::ValCommit< View, BranchTraits< View::VarType >::ValType >.
Definition at line 73 of file val-commit.hpp.
typedef BranchTraits<Var>::Commit Gecode::ValCommitFunction< View >::CommitFunction |
The corresponding commit function.
Definition at line 75 of file val-commit.hpp.
Constructor & Destructor Documentation
Gecode::ValCommitFunction< View >::ValCommitFunction | ( | Space & | home, | |
const ValBranch< Var > & | vb | |||
) | [inline] |
Constructor for initialization.
Definition at line 118 of file val-commit.hpp.
Gecode::ValCommitFunction< View >::ValCommitFunction | ( | Space & | home, | |
ValCommitFunction< View > & | vc | |||
) | [inline] |
Constructor for cloning during copying.
Definition at line 126 of file val-commit.hpp.
Member Function Documentation
ModEvent Gecode::ValCommitFunction< View >::commit | ( | Space & | home, | |
unsigned int | a, | |||
View | x, | |||
int | i, | |||
Val | n | |||
) | [inline] |
Perform user-defined commit.
Definition at line 132 of file val-commit.hpp.
NGL * Gecode::ValCommitFunction< View >::ngl | ( | Space & | home, | |
unsigned int | a, | |||
View | x, | |||
Val | n | |||
) | const [inline] |
Create no-good literal for alternative a.
Definition at line 141 of file val-commit.hpp.
void Gecode::ValCommitFunction< View >::print | ( | const Space & | home, | |
unsigned int | a, | |||
View | x, | |||
int | i, | |||
const Val & | n, | |||
std::ostream & | o | |||
) | const [inline] |
Print on o the alternative with view x at position i and value n.
Definition at line 146 of file val-commit.hpp.
bool Gecode::ValCommitFunction< View >::notice | ( | void | ) | const [inline] |
Whether dispose must always be called (that is, notice is needed).
Reimplemented from Gecode::ValCommit< View, BranchTraits< View::VarType >::ValType >.
Definition at line 153 of file val-commit.hpp.
void Gecode::ValCommitFunction< View >::dispose | ( | Space & | home | ) | [inline] |
Delete value commit.
Reimplemented from Gecode::ValCommit< View, BranchTraits< View::VarType >::ValType >.
Definition at line 158 of file val-commit.hpp.
Member Data Documentation
SharedData<CommitFunction> Gecode::ValCommitFunction< View >::c [protected] |
The user-defined commit function.
Definition at line 78 of file val-commit.hpp.
The documentation for this class was generated from the following file:
- gecode/kernel/branch/val-commit.hpp