Generated on Thu Nov 2 14:49:41 2006 for Gecode/J by doxygen 1.5.0

org.gecode.Propagator Class Reference
[Programming actors]

Inherits org.gecode.JavaPropagator.

Inherited by org.gecode.BinaryPropagator< GV extends GecodeView >, org.gecode.NaryOnePropagator< GV extends GecodeView >, and org.gecode.NaryPropagator< GV extends GecodeView >.

List of all members.


Detailed Description

Base class for programming Propagators.

Definition at line 35 of file Propagator.java.

Public Member Functions

 Propagator ()
void dispose (Space home)
final void dispose_internal (JavaSpace home)
 Deallocate.
Propagator copy (Space home, boolean share)
 Calls the copy-constructor of the current class.
final JavaPropagator copy_internal (JavaSpace home, boolean share)
 Create a copy of this propagator.
abstract ExecStatus propagate (Space home)
final ExecStatus propagate_internal (JavaSpace home)
 Propagation function.
abstract PropCost cost ()
final PropCost cost_internal ()
 Cost function.
abstract ExecStatus setup (Space home)
final ExecStatus setup_internal (JavaSpace home)
 Setup this propagator.

Protected Member Functions

ExecStatus t (ModEvent me, ExecStatus es)
 If me is failed, return ES_FAILED, else return es.
final PropCost cost_lo (int n, PropCost pc)
 Dynamic low-propagation cost computation.
final PropCost cost_hi (int n, PropCost pc)
 Dynamic high-propagation cost computation.


Constructor & Destructor Documentation

org.gecode.Propagator.Propagator (  ) 

Definition at line 38 of file Propagator.java.


Member Function Documentation

void org.gecode.Propagator.dispose ( Space  home  ) 

Reimplemented in org.gecode.NaryPropagator< GV extends GecodeView >.

Definition at line 42 of file Propagator.java.

final void org.gecode.Propagator.dispose_internal ( JavaSpace  home  ) 

Deallocate.

Reimplemented from org.gecode.JavaPropagator.

Definition at line 44 of file Propagator.java.

Propagator org.gecode.Propagator.copy ( Space  home,
boolean  share 
)

Calls the copy-constructor of the current class.

Definition at line 51 of file Propagator.java.

final JavaPropagator org.gecode.Propagator.copy_internal ( JavaSpace  home,
boolean  share 
)

Create a copy of this propagator.

Reimplemented from org.gecode.JavaPropagator.

Definition at line 83 of file Propagator.java.

abstract ExecStatus org.gecode.Propagator.propagate ( Space  home  )  [pure virtual]

final ExecStatus org.gecode.Propagator.propagate_internal ( JavaSpace  home  ) 

Propagation function.

Reimplemented from org.gecode.JavaPropagator.

Definition at line 98 of file Propagator.java.

abstract PropCost org.gecode.Propagator.cost (  )  [pure virtual]

final PropCost org.gecode.Propagator.cost_internal (  ) 

Cost function.

Reimplemented from org.gecode.JavaPropagator.

Definition at line 113 of file Propagator.java.

abstract ExecStatus org.gecode.Propagator.setup ( Space  home  )  [pure virtual]

final ExecStatus org.gecode.Propagator.setup_internal ( JavaSpace  home  ) 

Setup this propagator.

Reimplemented from org.gecode.JavaPropagator.

Definition at line 127 of file Propagator.java.

ExecStatus org.gecode.Propagator.t ( ModEvent  me,
ExecStatus  es 
) [protected]

If me is failed, return ES_FAILED, else return es.

Definition at line 144 of file Propagator.java.

final PropCost org.gecode.Propagator.cost_lo ( int  n,
PropCost  pc 
) [protected]

Dynamic low-propagation cost computation.

If n is less than 4, use constant low-costs, otherwise use pc.

Definition at line 152 of file Propagator.java.

final PropCost org.gecode.Propagator.cost_hi ( int  n,
PropCost  pc 
) [protected]

Dynamic high-propagation cost computation.

If n is less than 4, use constant high-costs, otherwise use pc.

Definition at line 162 of file Propagator.java.


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