org.jacop.constraints

Class Cumulative

java.lang.Object

org.jacop.constraints.DecomposedConstraint<Constraint>

org.jacop.constraints.Constraint

org.jacop.constraints.Cumulative

All Implemented Interfaces:

SatisfiedPresent

public class Cumulative
extends Constraint
implements SatisfiedPresent

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

Version:

4.9

Author:

Krzysztof Kuchcinski and Radoslaw Szymanek

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	doEdgeFinding It specifies if the edge finding algorithm should be used.
protected 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.
IntVar[]	resources It specifies/stores resource variable for each corresponding task.
protected boolean	setLimit It specifies if the data from profiles should be used to propagate onto limit variable.
IntVar[]	starts It specifies/stores start variables for each corresponding task.

Fields inherited from class org.jacop.constraints.Constraint

atomicExecution, consistencyPruningEvents, constraintScope, earlyTerminationOK, increaseWeight, numberId, scope, trace

Fields inherited from class org.jacop.constraints.DecomposedConstraint

queueIndex

Constructor Summary

Constructors

Constructor and Description
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.
Cumulative(IntVar[] starts, IntVar[] durations, IntVar[] resources, IntVar limit, boolean doEdgeFinding, boolean doProfile, boolean setLimit) It creates a cumulative constraint.
Cumulative(List<? extends IntVar> starts, List<? extends IntVar> durations, List<? extends IntVar> resources, IntVar limit) It creates a cumulative constraint.
Cumulative(List<? extends IntVar> starts, List<? extends IntVar> durations, List<? extends IntVar> resources, IntVar limit, boolean edgeFinding) It creates a cumulative constraint.
Cumulative(List<? extends IntVar> starts, List<? extends IntVar> durations, List<? extends IntVar> resources, IntVar limit, boolean edgeFinding, boolean profile) It creates a cumulative constraint.

Method Summary

Modifier and Type	Method and Description
void	consistency(Store store) It is a (most probably incomplete) consistency function which removes the values from variables domains.
int	getDefaultConsistencyPruningEvent()
boolean	satisfied() It checks if the constraint is satisfied.
String	toString() It produces a string representation of a constraint state.

Methods inherited from class org.jacop.constraints.Constraint

afc, arguments, cleanAfterFailure, decompose, getConsistencyPruningEvent, getGuideConstraint, getGuideValue, getGuideVariable, grounded, grounded, id, impose, impose, imposeDecomposition, increaseWeight, intArrayToString, long2int, numberArgs, queueVariable, removeConstraint, requiresMonotonicity, setConsistencyPruningEvent, setConstraintScope, setScope, setScope, setScope, setScope, setScope, setWatchedVariableGrounded, supplyGuideFeedback, updateAFC, watchedVariableGrounded

Methods inherited from class org.jacop.constraints.DecomposedConstraint

auxiliaryVariables, checkInput, checkInput, checkInputForDuplication, checkInputForDuplicationSkipSingletons, checkInputForNullness, checkInputForNullness, checkInputForNullness, derivative, getDubletonsSkipSingletons, imposeDecomposition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

doEdgeFinding

protected boolean doEdgeFinding

It specifies if the edge finding algorithm should be used.

doProfile

protected boolean doProfile

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

setLimit

protected boolean setLimit

It specifies if the data from profiles should be used 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.

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(IntVar[] starts,
                  IntVar[] durations,
                  IntVar[] resources,
                  IntVar limit,
                  boolean doEdgeFinding,
                  boolean doProfile,
                  boolean setLimit)

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.

setLimit - specifies if limit variable will be prunded.

Cumulative

public Cumulative(List<? extends IntVar> starts,
                  List<? extends IntVar> durations,
                  List<? 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(List<? extends IntVar> starts,
                  List<? extends IntVar> durations,
                  List<? 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(List<? extends IntVar> starts,
                  List<? extends IntVar> durations,
                  List<? 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

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.

getDefaultConsistencyPruningEvent

public int getDefaultConsistencyPruningEvent()

Specified by:

getDefaultConsistencyPruningEvent in class Constraint

satisfied

public boolean satisfied()

Description copied from interface: SatisfiedPresent

It checks if the constraint is satisfied. It can return false even if constraint is satisfied but not all variables in its scope are grounded. It needs to return true if all variables in its scope are grounded and constraint is satisfied.

Implementations of this interface for constraints that are not PrimitiveConstraint may require constraint imposition and consistency check as a requirement to work correctly.

Specified by:

satisfied in interface SatisfiedPresent

Returns:

true if constraint is possible to verify that it is satisfied.

toString

public String toString()

Description copied from class: Constraint

It produces a string representation of a constraint state.

Overrides:

toString in class Constraint