Module org.maxicp

Package org.maxicp.cp.engine.constraints.scheduling

Class CPStepAtEndCumulFunction

java.lang.Object

org.maxicp.cp.engine.constraints.scheduling.CPStepAtEndCumulFunction

All Implemented Interfaces:

CPCumulFunction, CumulFunction

public class CPStepAtEndCumulFunction
extends Object
implements CPCumulFunction

CP implementation of a Step at End Cumulative Function

Author:

Pierre Schaus, Charles Thomas, Augustin Delecluse

Field Summary

Fields

Modifier and Type	Field	Description
CPIntVar	height
final CPIntervalVar	var

Constructor Summary

Constructors

Constructor	Description
CPStepAtEndCumulFunction(CPIntervalVar var, int h)	Creates a step-at-end cumulative function for an interval variable with fixed step height h.
CPStepAtEndCumulFunction(CPIntervalVar var, int hMin, int hMax)	Creates a step-at-end cumulative function for an interval variable with step height in [hMin, hMax].

Method Summary

Modifier and Type	Method	Description
List<Activity>	flatten(boolean positive)	Returns a list of all the activities contributing to this cumulative function.
CPIntVar	heightAtEnd(IntervalVar interval)	Returns an IntExpression representing the height of the cumul function at the end of the interval variable given in parameter.
CPIntVar	heightAtStart(IntervalVar interval)	Returns an IntExpression representing the height of the cumul function at the start of the interval variable given in parameter.
boolean	inScope(IntervalVar interval)	Returns whether the interval var given in parameter contributes to the cumul function

Methods inherited from class java.lang.Object

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

Field Details

var

public final CPIntervalVar var

height

public CPIntVar height

Constructor Details

CPStepAtEndCumulFunction

public CPStepAtEndCumulFunction(CPIntervalVar var,
 int hMin,
 int hMax)

Creates a step-at-end cumulative function for an interval variable with step height in [hMin, hMax].

Parameters:

var - the interval variable at the end of which the step occurs

hMin - the minimum step height (must be > 0)

hMax - the maximum step height (must be >= hMin)

CPStepAtEndCumulFunction

public CPStepAtEndCumulFunction(CPIntervalVar var,
 int h)

Creates a step-at-end cumulative function for an interval variable with fixed step height h.

Parameters:

var - the interval variable at the end of which the step occurs

h - the fixed step height (must be > 0)

Method Details

flatten

public List<Activity> flatten(boolean positive)

Description copied from interface: CPCumulFunction

Returns a list of all the activities contributing to this cumulative function. Transformations are applied to the activities following the internal AST of the cumul function.

Specified by:

flatten in interface CPCumulFunction

Parameters:

positive - A boolean indicating the sign to be applied when flattening the cumul function

Returns:

A list of all the flattened activities contributing to this cumulative function.

inScope

public boolean inScope(IntervalVar interval)

Description copied from interface: CumulFunction

Returns whether the interval var given in parameter contributes to the cumul function

Specified by:

inScope in interface CPCumulFunction

Specified by:

inScope in interface CumulFunction

Parameters:

interval - an IntervalVar

Returns:

a boolean that indicates if interval contributes to the cumul function.

heightAtStart

public CPIntVar heightAtStart(IntervalVar interval)

Description copied from interface: CumulFunction

Returns an IntExpression representing the height of the cumul function at the start of the interval variable given in parameter.

Specified by:

heightAtStart in interface CPCumulFunction

Specified by:

heightAtStart in interface CumulFunction

Parameters:

interval - an IntervalVar

Returns:

an int expression representing the height of the cumul function at the start of interval

heightAtEnd

public CPIntVar heightAtEnd(IntervalVar interval)

Description copied from interface: CumulFunction

Returns an IntExpression representing the height of the cumul function at the end of the interval variable given in parameter.

Specified by:

heightAtEnd in interface CPCumulFunction

Specified by:

heightAtEnd in interface CumulFunction

Parameters:

interval - an IntervalVar

Returns:

an int expression representing the height of the cumul function at the end of interval