JaCoP.constraints
Class Cumulative

java.lang.Object
  JaCoP.constraints.DecomposedConstraint
      JaCoP.constraints.Constraint
          JaCoP.constraints.Cumulative

public class Cumulative
extends Constraint

Cumulative implements the cumulative/4 constraint using edge-finding algorithm and profile information on the resource use.

Author:

Krzysztof Kuchcinski and Radoslaw Szymanek

Field Summary

boolean	doEdgeFinding It specifies if the edge finding algorithm should be used.
boolean	doProfile It specifies if the profiles should be computed to propagate onto limit variable.
IntVar[]	durations It specifies/stores duration variables for each corresponding task.
IntVar	limit It specifies the limit of the profile of cumulative use of resources.
Profile	maxProfile It contains information about maximal profile contributed by tasks.
Profile	minProfile It contains information about minimal profile contributed by regions for certain occupied by tasks.
IntVar[]	resources It specifies/stores resource variable for each corresponding task.
IntVar[]	starts It specifies/stores start variables for each corresponding task.
static java.lang.String[]	xmlAttributes It specifies the arguments required to be saved by an XML format as well as the constructor being called to recreate an object from an XML format.

Fields inherited from class JaCoP.constraints.Constraint

atomicExecution, consistencyPruningEvents, earlyTerminationOK, id, increaseWeight, numberArgs, numberId

Fields inherited from class JaCoP.constraints.DecomposedConstraint

queueIndex

Constructor Summary

Cumulative(java.util.ArrayList<? extends IntVar> starts, java.util.ArrayList<? extends IntVar> durations, java.util.ArrayList<? extends IntVar> resources, IntVar limit)
It creates a cumulative constraint.

Cumulative(java.util.ArrayList<? extends IntVar> starts, java.util.ArrayList<? extends IntVar> durations, java.util.ArrayList<? extends IntVar> resources, IntVar limit, boolean edgeFinding)
It creates a cumulative constraint.

Cumulative(java.util.ArrayList<? extends IntVar> starts, java.util.ArrayList<? extends IntVar> durations, java.util.ArrayList<? extends IntVar> resources, IntVar limit, boolean edgeFinding, boolean profile)
It creates a cumulative constraint.

Cumulative(IntVar[] starts, IntVar[] durations, IntVar[] resources, IntVar limit)
It creates a cumulative constraint.

Cumulative(IntVar[] starts, IntVar[] durations, IntVar[] resources, IntVar limit, boolean edgeFinding)
It creates a cumulative constraint.

Cumulative(IntVar[] starts, IntVar[] durations, IntVar[] resources, IntVar limit, boolean doEdgeFinding, boolean doProfile)
It creates a cumulative constraint.

Method Summary

java.util.ArrayList<Var>	arguments() It returns the variables in a scope of the constraint.
void	consistency(Store store) It is a (most probably incomplete) consistency function which removes the values from variables domains.
int	getConsistencyPruningEvent(Var var) It retrieves the pruning event which causes reevaluation of the constraint.
java.lang.String	id() It gives the id string of a constraint.
void	impose(Store store) It imposes the constraint in a given store.
void	increaseWeight() It increases the weight of the variables in the constraint scope.
void	removeConstraint() It removes the constraint by removing this constraint from all variables.
boolean	satisfied() It checks if the constraint is satisfied.
java.lang.String	toString() It produces a string representation of a constraint state.

Methods inherited from class JaCoP.constraints.Constraint

cleanAfterFailure, decompose, getGuideConstraint, getGuideValue, getGuideVariable, impose, imposeDecomposition, numberArgs, queueVariable, removeLevel, removeLevelLate, requiresMonotonicity, setConsistencyPruningEvent, supplyGuideFeedback

Methods inherited from class JaCoP.constraints.DecomposedConstraint

auxiliaryVariables, imposeDecomposition

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

maxProfile

public Profile maxProfile

It contains information about maximal profile contributed by tasks.

minProfile

public Profile minProfile

It contains information about minimal profile contributed by regions for certain occupied by tasks.

doEdgeFinding

public boolean doEdgeFinding

It specifies if the edge finding algorithm should be used.

doProfile

public boolean doProfile

It specifies if the profiles should be computed to propagate onto limit variable.

limit

public IntVar limit

It specifies the limit of the profile of cumulative use of resources.

starts

public IntVar[] starts

It specifies/stores start variables for each corresponding task.

durations

public IntVar[] durations

It specifies/stores duration variables for each corresponding task.

resources

public IntVar[] resources

It specifies/stores resource variable for each corresponding task.

xmlAttributes

public static java.lang.String[] xmlAttributes

It specifies the arguments required to be saved by an XML format as well as the constructor being called to recreate an object from an XML format.

Constructor Detail

Cumulative

public Cumulative(IntVar[] starts,
                  IntVar[] durations,
                  IntVar[] resources,
                  IntVar limit,
                  boolean doEdgeFinding,
                  boolean doProfile)

It creates a cumulative constraint.

Parameters:

starts - variables denoting starts of the tasks.

durations - variables denoting durations of the tasks.

resources - variables denoting resource usage of the tasks.

limit - the overall limit of resources which has to be used.

doEdgeFinding - true if edge finding algorithm should be used.

doProfile - specifies if the profiles should be computed in order to reduce limit variable.

Cumulative

public Cumulative(java.util.ArrayList<? extends IntVar> starts,
                  java.util.ArrayList<? extends IntVar> durations,
                  java.util.ArrayList<? extends IntVar> resources,
                  IntVar limit)

It creates a cumulative constraint.

Parameters:

starts - variables denoting starts of the tasks.

durations - variables denoting durations of the tasks.

resources - variables denoting resource usage of the tasks.

limit - the overall limit of resources which has to be used.

Cumulative

public Cumulative(java.util.ArrayList<? extends IntVar> starts,
                  java.util.ArrayList<? extends IntVar> durations,
                  java.util.ArrayList<? extends IntVar> resources,
                  IntVar limit,
                  boolean edgeFinding)

It creates a cumulative constraint.

Parameters:

starts - variables denoting starts of the tasks.

durations - variables denoting durations of the tasks.

resources - variables denoting resource usage of the tasks.

limit - the overall limit of resources which has to be used.

edgeFinding - true if edge finding algorithm should be used.

Cumulative

public Cumulative(java.util.ArrayList<? extends IntVar> starts,
                  java.util.ArrayList<? extends IntVar> durations,
                  java.util.ArrayList<? extends IntVar> resources,
                  IntVar limit,
                  boolean edgeFinding,
                  boolean profile)

It creates a cumulative constraint.

Parameters:

starts - variables denoting starts of the tasks.

durations - variables denoting durations of the tasks.

resources - variables denoting resource usage of the tasks.

limit - the overall limit of resources which has to be used.

edgeFinding - true if edge finding algorithm should be used.

profile - specifies if the profiles should be computed in order to reduce limit variable.

Cumulative

public Cumulative(IntVar[] starts,
                  IntVar[] durations,
                  IntVar[] resources,
                  IntVar limit)

It creates a cumulative constraint.

Parameters:

starts - variables denoting starts of the tasks.

durations - variables denoting durations of the tasks.

resources - variables denoting resource usage of the tasks.

limit - the overall limit of resources which has to be used.

Cumulative

public Cumulative(IntVar[] starts,
                  IntVar[] durations,
                  IntVar[] resources,
                  IntVar limit,
                  boolean edgeFinding)

It creates a cumulative constraint.

Parameters:

starts - variables denoting starts of the tasks.

durations - variables denoting durations of the tasks.

resources - variables denoting resource usage of the tasks.

limit - the overall limit of resources which has to be used.

edgeFinding - true if edge finding algorithm should be used.

Method Detail

arguments

public java.util.ArrayList<Var> arguments()

Description copied from class: Constraint

It returns the variables in a scope of the constraint.

Specified by:

arguments in class Constraint

Returns:

variables in a scope of the constraint.

consistency

public void consistency(Store store)

Description copied from class: Constraint

It is a (most probably incomplete) consistency function which removes the values from variables domains. Only values which do not have any support in a solution space are removed.

Specified by:

consistency in class Constraint

Parameters:

store - constraint store within which the constraint consistency is being checked.

getConsistencyPruningEvent

public int getConsistencyPruningEvent(Var var)

Description copied from class: Constraint

It retrieves the pruning event which causes reevaluation of the constraint.

Specified by:

getConsistencyPruningEvent in class Constraint

Parameters:

var - variable for which pruning event is retrieved

Returns:

it returns the int code of the pruning event (GROUND, BOUND, ANY, NONE)

id

public java.lang.String id()

Description copied from class: Constraint

It gives the id string of a constraint.

Specified by:

id in class Constraint

Returns:

string id of the constraint.

impose

public void impose(Store store)

Description copied from class: Constraint

It imposes the constraint in a given store.

Specified by:

impose in class Constraint

Parameters:

store - the constraint store to which the constraint is imposed to.

removeConstraint

public void removeConstraint()

Description copied from class: Constraint

It removes the constraint by removing this constraint from all variables.

Specified by:

removeConstraint in class Constraint

satisfied

public boolean satisfied()

Description copied from class: Constraint

It checks if the constraint is satisfied. If this function is incorrectly implemented a constraint may not be satisfied in a solution.

Specified by:

satisfied in class Constraint

Returns:

true if the constraint is for certain satisfied, false otherwise.

toString

public java.lang.String toString()

Description copied from class: Constraint

It produces a string representation of a constraint state.

Specified by:

toString in class Constraint

increaseWeight

public void increaseWeight()

Description copied from class: Constraint

It increases the weight of the variables in the constraint scope.

Specified by:

increaseWeight in class Constraint