Gecode::VarImp< VIC > Class Template Reference
[Programming variables]
Base-class for variable implementations. More...
#include <core.hpp>
Public Member Functions | |
VarImp (Space &home) | |
Creation. | |
VarImp (void) | |
Creation of static instances. | |
Protected Member Functions | |
void | cancel (Space &home) |
Cancel all subscriptions when variable implementation is assigned. | |
bool | advise (Space &home, ModEvent me, Delta &d) |
Run advisors when variable implementation has been modified with modification event me and domain change d. | |
ModEvent | fail (Space &home) |
Run advisors to be run on failure and returns ME_GEN_FAILED. | |
void | schedule (Space &home, PropCond pc1, PropCond pc2, ModEvent me) |
Schedule subscribed propagators. | |
Dependencies | |
| |
void | subscribe (Space &home, Propagator &p, PropCond pc, bool assigned, ModEvent me, bool schedule) |
Subscribe propagator p with propagation condition pc. | |
void | cancel (Space &home, Propagator &p, PropCond pc) |
Cancel subscription of propagator p with propagation condition pc. | |
void | subscribe (Space &home, Advisor &a, bool assigned, bool fail) |
Subscribe advisor a to variable. | |
void | cancel (Space &home, Advisor &a, bool fail) |
Cancel subscription of advisor a. | |
unsigned int | degree (void) const |
Return degree (number of subscribed propagators and advisors). | |
double | afc (void) const |
Return accumulated failure count (plus degree). | |
Cloning variables | |
| |
VarImp (Space &home, VarImp &x) | |
Constructor for cloning. | |
bool | copied (void) const |
Is variable already copied. | |
VarImp * | forward (void) const |
Use forward pointer if variable already copied. | |
VarImp * | next (void) const |
Return next copied variable. | |
Bit management | |
| |
unsigned int | bits (void) const |
Provide access to free bits. | |
unsigned int & | bits (void) |
Provide access to free bits. | |
Variable implementation-dependent propagator support | |
| |
static void | schedule (Space &home, Propagator &p, ModEvent me, bool force=false) |
Schedule propagator p with modification event me. | |
static void | reschedule (Space &home, Propagator &p, PropCond pc, bool assigned, ModEvent me) |
Schedule propagator p. | |
static ModEvent | me (const ModEventDelta &med) |
Project modification event for this variable type from med. | |
static ModEventDelta | med (ModEvent me) |
Translate modification event me into modification event delta. | |
static ModEvent | me_combine (ModEvent me1, ModEvent me2) |
Combine modifications events me1 and me2. | |
Delta information for advisors | |
| |
static ModEvent | modevent (const Delta &d) |
Return modification event. | |
Memory management | |
| |
static void * | operator new (size_t, Space &) |
Allocate memory from space. | |
static void | operator delete (void *, Space &) |
Return memory to space. | |
static void | operator delete (void *) |
Needed for exceptions. |
Detailed Description
template<class VIC>
class Gecode::VarImp< VIC >
Base-class for variable implementations.
Implements variable implementation for variable implementation configuration of type VIC.
Definition at line 218 of file core.hpp.
Constructor & Destructor Documentation
Gecode::VarImp< VIC >::VarImp | ( | Space & | home | ) | [inline] |
Gecode::VarImp< VIC >::VarImp | ( | void | ) | [inline] |
Gecode::VarImp< VIC >::VarImp | ( | Space & | home, | |
VarImp< VIC > & | x | |||
) | [inline] |
Member Function Documentation
void Gecode::VarImp< VIC >::cancel | ( | Space & | home | ) | [inline, protected] |
bool Gecode::VarImp< VIC >::advise | ( | Space & | home, | |
ModEvent | me, | |||
Delta & | d | |||
) | [inline, protected] |
ModEvent Gecode::VarImp< VIC >::fail | ( | Space & | home | ) | [inline, protected] |
void Gecode::VarImp< VIC >::subscribe | ( | Space & | home, | |
Propagator & | p, | |||
PropCond | pc, | |||
bool | assigned, | |||
ModEvent | me, | |||
bool | schedule | |||
) | [inline] |
Subscribe propagator p with propagation condition pc.
In case schedule is false, the propagator is just subscribed but not scheduled for execution (this must be used when creating subscriptions during propagation).
In case the variable is assigned (that is, assigned is true), the subscribing propagator is scheduled for execution. Otherwise, the propagator subscribes and is scheduled for execution with modification event me provided that pc is different from PC_GEN_ASSIGNED.
void Gecode::VarImp< VIC >::cancel | ( | Space & | home, | |
Propagator & | p, | |||
PropCond | pc | |||
) | [inline] |
Cancel subscription of propagator p with propagation condition pc.
Reimplemented in Gecode::Int::BoolVarImp.
void Gecode::VarImp< VIC >::subscribe | ( | Space & | home, | |
Advisor & | a, | |||
bool | assigned, | |||
bool | fail | |||
) | [inline] |
Subscribe advisor a to variable.
The advisor a is only subscribed if assigned is false.
If fail is true, the advisor a is also run when a variable operation triggers failure. This feature is undocumented.
Reimplemented in Gecode::Int::IntVarImpBase, Gecode::Int::BoolVarImpBase, Gecode::Set::SetVarImpBase, and Gecode::Float::FloatVarImpBase.
void Gecode::VarImp< VIC >::cancel | ( | Space & | home, | |
Advisor & | a, | |||
bool | fail | |||
) | [inline] |
Cancel subscription of advisor a.
Reimplemented in Gecode::Int::BoolVarImp.
unsigned int Gecode::VarImp< VIC >::degree | ( | void | ) | const [inline] |
double Gecode::VarImp< VIC >::afc | ( | void | ) | const [inline] |
bool Gecode::VarImp< VIC >::copied | ( | void | ) | const [inline] |
VarImp< VIC > * Gecode::VarImp< VIC >::forward | ( | void | ) | const [inline] |
VarImp* Gecode::VarImp< VIC >::next | ( | void | ) | const |
Return next copied variable.
void Gecode::VarImp< VIC >::schedule | ( | Space & | home, | |
Propagator & | p, | |||
ModEvent | me, | |||
bool | force = false | |||
) | [inline, static] |
void Gecode::VarImp< VIC >::reschedule | ( | Space & | home, | |
Propagator & | p, | |||
PropCond | pc, | |||
bool | assigned, | |||
ModEvent | me | |||
) | [inline, static] |
ModEvent Gecode::VarImp< VIC >::me | ( | const ModEventDelta & | med | ) | [inline, static] |
ModEventDelta Gecode::VarImp< VIC >::med | ( | ModEvent | me | ) | [inline, static] |
Translate modification event me into modification event delta.
Reimplemented in Gecode::Float::FloatVarImp, Gecode::Int::IntVarImp, and Gecode::Int::BoolVarImp.
ModEvent Gecode::VarImp< VIC >::me_combine | ( | ModEvent | me1, | |
ModEvent | me2 | |||
) | [inline, static] |
ModEvent Gecode::VarImp< VIC >::modevent | ( | const Delta & | d | ) | [inline, static] |
Return modification event.
Reimplemented in Gecode::Int::BoolVarImp.
unsigned int Gecode::VarImp< VIC >::bits | ( | void | ) | const [inline] |
unsigned int & Gecode::VarImp< VIC >::bits | ( | void | ) | [inline] |
void Gecode::VarImp< VIC >::schedule | ( | Space & | home, | |
PropCond | pc1, | |||
PropCond | pc2, | |||
ModEvent | me | |||
) | [inline, protected] |
void * Gecode::VarImp< VIC >::operator new | ( | size_t | s, | |
Space & | home | |||
) | [inline, static] |
void Gecode::VarImp< VIC >::operator delete | ( | void * | , | |
Space & | ||||
) | [inline, static] |
void Gecode::VarImp< VIC >::operator delete | ( | void * | ) | [inline, static] |
Member Data Documentation
ActorLink** Gecode::VarImp< VIC >::base |
VarImp<VIC>* Gecode::VarImp< VIC >::fwd |
unsigned int Gecode::VarImp< VIC >::idx [inline] |
Indices of subscribed actors.
The entries from base[0] to base[idx[pc_max]] are propagators, where the entries between base[idx[pc-1]] and base[idx[pc]] are the propagators that have subscribed with propagation condition pc.
The entries between base[idx[pc_max]] and base[idx[pc_max+1]] are the advisors subscribed to the variable implementation.
VarImp< VIC > * Gecode::VarImp< VIC >::next [inline] |
The documentation for this class was generated from the following file:
- gecode/kernel/core.hpp