Functions

The following functions can be used in a CP Optimizer model file (CPO file):

abs
Computes the absolute value of an expression.
abstraction
Returns a constraint that abstracts the values of one array as values in another array.
allMinDistance
Constraint on the minimum absolute distance between a pair of integer expressions in an array.
alldiff
Ensures a number of expressions contain no duplicate values.
allowedAssignments
Explicitly defines possible assignments on one or more integer expressions.
alternative
Creates an alternative constraint between interval variables.
alwaysConstant
This constraint ensures a constant state for a state function on an interval.
alwaysEqual
This constraint fixes a given state for a state function during a variable or fixed interval.
alwaysIn
These constraints restrict the possible values of a cumulExpr or stateFunction to a particular range during a variable or fixed interval.
alwaysNoState
This constraint ensures that a state function is undefined on an interval.
before
Constrains an interval variable to be before another interval variable in a sequence.
boolAbstraction
Creates a constraint that abstracts the values of one array as Boolean values in another array.
coordinatePiecewiseLinear
Evaluates piecewise-linear function given by set of breaking points and values.
count
Returns the number of occurrences of a given value found in a given integer expression array.
countDifferent
Returns the number of different values in a given integer expression array.
cumulRange
Limits the range of a cumul function expression.
distribute
Calculates and/or constrains the distribution of values taken by an array of integer expressions.
element
This function returns an element of a given array indexed by an integer expression for use in a constraint or another expression.
endAtEnd
Constrains the delay between the ends of two interval variables.
endAtStart
Constrains the delay between the end of one interval variable and start of another one.
endBeforeEnd
Constrains the minimum delay between the ends of two interval variables.
endBeforeStart
Constrains minimum delay between the end of one interval variable and start of another one.
endEval
Evaluates segmentedFunction at the end of an interval variable.
endOf
Returns the end of specified interval variable.
endOfNext
Returns an integer expression that represents the end of the interval variable that is next.
endOfPrev
Returns an integer expression that represents the end of the interval variable that is previous.
exponent
Returns the exponent of its argument.
false
Returns a false Boolean expression.
first
Constrains an interval variable to be the first in a sequence.
forbidEnd
Forbids an interval variable to end during specified regions.
forbidExtent
Forbids an interval variable to overlap with specified regions.
forbidStart
Forbids an interval variable to start during specified regions.
forbiddenAssignments
Explicitly defines forbidden assignments for one or more integer expressions.
heightAtEnd
Returns the contribution of an interval variable to a cumul function at its end point.
heightAtStart
Returns the contribution of an interval variable to a cumul function at its start point.
inferred
An annotation which identifies certain variables as having their values inferred by the values taken on by non-inferred variables.
intVar
Creates a new integer variable.
intervalVar
Creates a new interval variable.
inverse
Constrains elements of one array to be inverses of another.
isomorphism
Returns an isomorphism constraint between two sets of interval variables.
last
Constrains an interval variable to be the last in a sequence.
lengthEval
Evaluates segmentedFunction using the length of an interval variable.
lengthOf
Returns the length of specified interval variable.
lengthOfNext
Returns an integer expression that represents the length of the interval variable that is next.
lengthOfPrev
Returns an integer expression that represents the length of the interval variable that is previous.
lexicographic
Returns a constraint which maintains two arrays to be lexicographically ordered.
log
Returns the logarithm of the input.
max
Computes the maximum of a pair or array of integer or floating-point expressions.
maximize
A function to specify an optimization problem. It asks CP Optimizer to seek to maximize the value of an expression.
maximizeStaticLex
A function to specify an optimization problem. It asks CP Optimizer to seek to lexicographically maximize the values of a number of expressions.
min
Computes the minimum of a pair or array of integer or floating-point expressions.
minimize
A function to specify an optimization problem. It asks CP Optimizer to seek to minimize the value of an expression.
minimizeStaticLex
A function to specify an optimization problem. It asks CP Optimizer to seek to lexicographically minimize the values of a number of expressions.
noOverlap
Constrains a set of interval variables not to overlap each others.
overlapLength
Returns the length of the overlap of two interval variables.
pack
Maintains the load on a set of containers given objects sizes and assignments.
presenceOf
Returns the presence status of specified interval variable.
previous
Constrains an interval variable to be previous to another interval variable in a sequence.
pulse
Returns an elementary cumul function of constant value between the start and the end of an interval.
range
Restricts the bounds of an integer or floating-point expression.
sameCommonSubsequence
This function creates a same-common-subsequence constraint between two sequence variables.
sameSequence
This function creates a same-sequence constraint between two sequence variables.
scalProd
Returns the scalar product of two vectors.
segmentedFunction
Creates a new piecewise linear function.
sequence
Constrains occurences of specified values in an array of expressions.
sequenceVar
Creates new sequence variable.
sizeEval
Evaluates segmentedFunction using the size of an interval variable.
sizeOf
Returns the size of a specified interval variable.
sizeOfNext
Returns an integer expression that represents the size of the interval variable that is next.
sizeOfPrev
Returns an integer expression that represents the size of the interval variable that is previous.
slopePiecewiseLinear
Evaluates piecewise-linear function given by set of breaking points and slopes.
span
Creates a span constraint between interval variables.
square
Returns the square of the input.
standardDeviation
Creates a constrained numeric expression equal to the standard deviation of the values of the variables in an array.
startAtEnd
Constrains the delay between the start of one interval variable and end of another one.
startAtStart
Constrains the delay between the starts of two interval variables.
startBeforeEnd
Constrains minimum delay between the start of one interval variable and end of another one.
startBeforeStart
Constrains the minimum delay between starts of two interval variables.
startEval
Evaluates segmentedFunction at the start of an interval variable.
startOf
Returns the start of a specified interval variable.
startOfNext
Returns an integer expression that represents the start of the interval variable that is next.
startOfPrev
Returns an integer expression that represents the start of the interval variable that is previous.
stateFunction
Creates a new state function.
stepAt
Returns an elementary cumul function of constant value after a given point.
stepAtEnd
Returns an elementary cumul function of constant value after the end of an interval.
stepAtStart
Returns an elementary cumul function of constant value after the start of an interval.
stepFunction
Creates a new step function (a function that remains constant within each of a series of adjacent intervals but changes in value from one interval to the next).
strictLexicographic
Returns a constraint which maintains two arrays to be lexicographically ordered in strict order.
strong
A model annotation to encourage CP Optimizer to produce stronger (higher inference) constraints.
subCircuit
Returns a constraint which maintains a circuit or subCircuit given successor variables.
sum
Returns the sum of the input.
synchronize
Creates a synchronization constraint between interval variables.
transitionMatrix
Creates a new square matrix of minimum transition times.
true
Returns a true Boolean expression.
typeOfNext
Returns an integer expression that represents the type of the interval variable that is next.
typeOfPrev
Returns an integer expression that represents the type of the interval variable that is previous.

Parent topic: CP Optimizer File Format Reference Manual