Generated on Mon Nov 30 23:53:42 2009 for Gecode by doxygen 1.6.1

Status of constraint propagation and branching commit
[Programming actors]

Functions

ExecStatus Gecode::ES_SUBSUMED (Propagator &p, size_t s)
 Propagator p is subsumed
ExecStatus Gecode::ES_SUBSUMED (Propagator &p, Space &home)
 Propagator p is subsumed
ExecStatus Gecode::ES_FIX_PARTIAL (Propagator &p, const ModEventDelta &med)
 Propagator p has computed partial fixpoint
ExecStatus Gecode::ES_NOFIX_PARTIAL (Propagator &p, const ModEventDelta &med)
 Propagator p has not computed partial fixpoint
template<class A >
ExecStatus Gecode::ES_SUBSUMED_FIX (A &a, Space &home, Council< A > &c)
 Advisor a is subsumed
template<class A >
ExecStatus Gecode::ES_SUBSUMED_NOFIX (A &a, Space &home, Council< A > &c)
 Advisor a is subsumed

Detailed Description

Note that the enum values starting with a double underscore should not be used directly. Instead, use the provided functions with the same name without leading underscores.


Function Documentation

ExecStatus Gecode::ES_SUBSUMED ( Propagator &  p,
size_t  s 
) [inline]

Propagator p is subsumed

The size of the propagator is s.

Note that the propagator must be subsumed and also disposed. So in general, there should be code such as

 return ES_SUBSUMED(*this,dispose(home)) 

.

However, in case the propagator has nothing to dispose (all its views are assigned and no external resources) it is sufficient to do

 return ES_SUBSUMED(*this,sizeof(*this)) 

.

Warning:
Has a side-effect on the propagator. Overwrites the modification event delta of a propagator. Use only directly with returning from propagation.

Definition at line 2549 of file core.hpp.

ExecStatus Gecode::ES_SUBSUMED ( Propagator &  p,
Space &  home 
) [inline]

Propagator p is subsumed

First disposes the propagator and then returns subsumption.

Warning:
Has a side-effect on the propagator. Overwrites the modification event delta of a propagator. Use only directly with returning from propagation.

Definition at line 2555 of file core.hpp.

ExecStatus Gecode::ES_FIX_PARTIAL ( Propagator &  p,
const ModEventDelta &  med 
) [inline]

Propagator p has computed partial fixpoint

Set modification event delta to med and schedule propagator accordingly.

Warning:
Has a side-effect on the propagator. Use only directly with returning from propagation.

Definition at line 2561 of file core.hpp.

ExecStatus Gecode::ES_NOFIX_PARTIAL ( Propagator &  p,
const ModEventDelta &  med 
) [inline]

Propagator p has not computed partial fixpoint

Combine current modification event delta with and schedule propagator accordingly.

Warning:
Has a side-effect on the propagator. Use only directly with returning from propagation.

Definition at line 2568 of file core.hpp.

template<class A >
ExecStatus Gecode::ES_SUBSUMED_FIX ( A a,
Space &  home,
Council< A > &  c 
) [inline]

Advisor a is subsumed

Disposes the advisor and:

  • returns subsumption.
  • returns that the propagator of a need not be run.
Warning:
Has a side-effect on the advisor. Use only directly when returning from advise.

Definition at line 2708 of file core.hpp.

template<class A >
ExecStatus Gecode::ES_SUBSUMED_NOFIX ( A a,
Space &  home,
Council< A > &  c 
) [inline]

Advisor a is subsumed

Disposes the advisor and:

  • returns subsumption.
  • returns that the propagator of a must be run.
Warning:
Has a side-effect on the advisor. Use only directly when returning from advise.

Definition at line 2715 of file core.hpp.