OPL functions

Description, syntax, and example for each individual OPL function.

Summary table of OPL functions
Provides the syntax and short description of each OPL function, with a link to the corresponding full description.
<= (scheduling)
OPL (scheduling) constraint used on a cumulative function.
abs
OPL function for the absolute value
allDifferent
OPL function to constrain all integer variables in an array to have different values.
allMinDistance
OPL function to constrain all int dvar to minimum value differences
allowedAssignments
OPL function for legal value combinations
alternative
OPL constraint (scheduling) used to create an exclusive alternative interval
alwaysConstant
OPL constraint (scheduling) used on a state function
alwaysEqual
OPL constraint (scheduling) used on a state function
alwaysIn
OPL constraint (scheduling) used on a cumulative function or a state function
alwaysNoState
OPL constraint (scheduling) used on a state function
append
OPL function to produce new arrays of integers, integer variables, or interval variables through concatenation
asSet
OPL function to convert a range to a set
before
OPL function (scheduling) to sequence interval variables
card
OPL function for the cardinality
ceil
OPL function to return the smallest integer greater than or equal to a value.
count
OPL function to count variables of a certain value.
cumulFunctionValue
OPL function (scheduling) to return the value of a cumulative function.
distToInt
OPL function to return the distance from a value to the nearest integer
dual
Obtains dual values from constraints.
element
OPL function to return an indexed element
endAtEnd
OPL constraint (scheduling) to restrict relative positions of interval variables.
endAtStart
OPL constraint (scheduling) to restrict the relative positions of interval variables.
endBeforeEnd
OPL constraint (scheduling) to restrict the relative positions of interval variables.
endBeforeStart
OPL constraint (scheduling) to restrict the relative positions of interval variables.
endEval
OPL numerical expression (scheduling) used to evaluate a piecewise linear function at the end of an interval
endOf
OPL integer expression (scheduling) to access the end time of an interval
endOfNext
An OPL function (scheduling) that returns the end of the next interval in a given sequence.
endOfPrev
An OPL function (scheduling) that returns the end of the previous interval in a given sequence.
exp
OPL exponent function
first
OPL function to return the first element in a set.
first (scheduling)
OPL function (scheduling) to sequence interval variables
floatValue
OPL function to convert a string to a float
floor
OPL function to return the largest integer smaller than or equal to a value
forbiddenAssignments
OPL function for illegal value combinations
forbidEnd
OPL constraint (scheduling) to limit the end of an interval variable.
forbidExtent
OPL constraint (scheduling) to affect the extent of an interval variable.
forbidStart
OPL constraint (scheduling) to limit the start of an interval variable.
frac
OPL function for the fractional part
ftoi
OPL function to convert a float to an integer
heightAtEnd
OPL expression (scheduling) used with a cumulative function
heightAtStart
OPL expression (scheduling) used with a cumulative function
intValue
OPL function to convert a string to an integer
inverse
OPL function to compute the inverse of values of arrays of integer decision variables.
isomorphism
OPL (scheduling) constraint used to model a one-to-one correspondence between the intervals present in two arrays.
item
OPL function to access the n-th item of a set or a tuple from a tuple set.
last
OPL function to return the last element in a set.
last (scheduling)
OPL function (scheduling) to sequence interval variables
length
OPL function to return the number of characters of a string
lengthEval
OPL numerical expression (scheduling) used to evaluate a piecewise linear function on the length of an interval
lengthOf
OPL integer expression (scheduling) to access the length of an interval
lengthOfNext
An OPL function (scheduling) that returns the length of the next interval in a given sequence.
lengthOfPrev
An OPL function (scheduling) that returns the length of the previous interval in a given sequence.
lex
OPL function to sort in lexicographic order
lg
OPL function for the base–2 log
ln
OPL function for the natural log
log
OPL function for the base–10 logarithm
matchAt
OPL function to get the first position of a substring
maxl
OPL function to return the maximal value
minl
OPL function to return the minimal value
next
OPL function to return the successor to an element
nextc
A circular version of the function next
noOverlap
OPL constraint (scheduling) used to prevent intervals in a sequence from overlapping and (optionally) to enforce a minimal distance between consecutive intervals.
numberOfSegments
OPL function (scheduling) to return the number of segments of a cumulative or state function in the solution.
ord
OPL function to return the position of an element
overlapLength
OPL function (CP, scheduling) to return the length of the overlap of two interval variables, or an interval variable and a constant interval.
pack
OPL function. A constraint to maintain the load of a set of containers
pow
OPL “power” function
presenceOf
OPL constraint (scheduling) used to enforce the presence of intervals
prev
OPL function to return the predecessor to an element
prev (scheduling)
OPL function (scheduling) to sequence interval variables
prevc
A circular version of the function prev
pulse
OPL expression (scheduling) of a cumulative function
rand
OPL function to return a pseudorandom integer
reducedCost
OPL function to obtain the reduced cost values from decision variables.
round
OPL function to return the nearest integer
sameCommonSubsequence
A binary constraint on a pair of sequence variables. The constraint states that the relative position of some related subsets of interval variables is the same in both sequences, seq1 and seq2.
sameSequence
A binary constraint on a pair of sequence variables. The constraint states that the relative position of related interval variables is the same in both sequences, seq1 and seq2.
segmentEnd
OPL function (scheduling) to return the end of the indexed segment of a cumulative function or a state function in the solution.
segmentStart
OPL function (scheduling) to return the start of a segment of a cumulative or state function.
segmentValue
OPL function (scheduling) to return the value of a segment of a cumulative or state function.
sgn
OPL function for the sign of expressions
sizeEval
OPL numerical expression (scheduling) used to evaluate a piecewise linear function on the size of an interval
sizeOf
OPL integer expression (scheduling) to access the size of an interval
sizeOfNext
An OPL function (scheduling) that returns the size of the next interval in a given sequence.
sizeOfPrev
An OPL function (scheduling) that returns the size of the previous interval in a given sequence.
slack
Obtains slack values from constraints.
span
OPL constraint (scheduling) used to span intervals
sqrt
OPL square root function
srand
OPL function for a generator of pseudo random numbers
standardDeviation
OPL function to return the standard deviation of an array
startAtEnd
OPL constraint (scheduling) to restrict the relative positions of interval variables.
startAtStart
OPL constraint (scheduling) to restrict the relative positions of interval variables.
startBeforeEnd
OPL constraint (scheduling) to restrict the relative positions of interval variables.
startBeforeStart
OPL constraint (scheduling) to restrict the relative positions of interval variables.
startEval
OPL numerical expression (scheduling) used to evaluate a piecewise linear function at the start of an interval
startOf
OPL integer expression (scheduling) to access the start time of an interval
startOfNext
An OPL function (scheduling) that returns the start of the next interval in a given sequence.
startOfPrev
An OPL function (scheduling) that returns the start of the previous interval in a given sequence.
stateFunctionValue
OPL function (scheduling) to return the value of a state function.
staticLex
OPL function for use in CPLEX or CP Optimizer models with a multi-criteria objective.
staticLexFull
OPL function for use in CPLEX models with a multi-criteria objective.
step
OPL expression (scheduling) of a cumulative function
stepAtEnd
OPL expression (scheduling) of a cumulative function
stepAtStart
OPL expression (scheduling) of a cumulative function
strictLex
OPL function to sort in strict lexicographic order
strong
For constraint programming: gives a strengthening indication on a set of variables.
synchronize
OPL constraint (scheduling) used to synchronize the start and end of intervals.
trunc
OPL function to return the integer part
typeOfNext
An OPL function (scheduling) that returns the type of the next interval in a given sequence.
typeOfPrev
An OPL function (scheduling) that returns the type of the previous interval in a given sequence.

Parent topic: Language Quick Reference