LSOperator Enumeration¶
- enum localsolver.LSOperator¶
Mathematical operators available for modeling. These operators are used to type the expressions created in a LocalSolver optimization model.
- See
- See
- Bool¶
Boolean decision. Decisional operator with no operand. Decision variable with domain
{0,1}
.
- Float¶
Float decision. Operator with two operands that represent the lower bound and the upper bound of the decision (domain
[lb, ub]
). The bounds must be constants (integers or doubles).- Since
4.0
- Const¶
Constant. Operator with no argument. Constants can be booleans, long or doubles. Note that constants 0 or 1 are considered as boolean. Constants are implicitly created when passing long or double arguments to
LSModel.CreateExpression
orLSExpression.AddOperand
. They can also be created with the dedicated functionLSModel.CreateConstant
.
- Sum¶
Sum. N-ary arithmetic operator.
SUM(e1, e2, ..., eN)
is equal to the sum of all operandse1, e2, ..., eN
. This operator returns an integer if all the operands are booleans or integers and a double as soon as one operand is a double.With collections (lists, sets), 1D arrays or intervals
This operator can also be used with intervals,
List
,Set
or 1DArray
to create expressions with a dynamic number of operands. In that case, this operator becomes a binary operator that takes an interval, a list, a set or a 1D array as first operand and aLambdaFunction
as second operand. The operator will call the function on each value of the interval, list, set or 1D array and will sum all the values computed and returned by the function.
- Sub¶
Substraction. Binary arithmetic operator.
SUB(x, y)
is equal to the value ofx - y
. This operator returns an integer if the two operands are booleans or integers, and a double as soon as one operand is a double.- Since
4.0
- Prod¶
Product. N-ary arithmetic operator.
PROD(e1, e2, ..., eN)
is equal to the product of all operandse1, e2, ..., eN
. This operator returns an integer if all the operands are booleans or integers, and a double as soon as one operand is a double.With collections (lists, sets), 1D arrays or intervals
This operator can also be used with intervals,
List
,Set
or 1DArray
to create expressions with a dynamic number of operands. In that case, this operator becomes a binary operator that takes an interval, a list, a set or a 1D array as first operand and aLambdaFunction
as second operand. The operator will call the function on each value of the interval, list, set or 1D array and will compute the product of all the values returned by the function.
- Max¶
Maximum. N-ary arithmetic operator.
MAX(e1, e2, ..., eN)
is equal to the maximum value among all operandse1, e2, ..., eN
. This operator returns an integer if all the operands are booleans or integers, and a double as soon as one operand is a double.With collections (lists, sets), 1D arrays or intervals
This operator can also be used with intervals,
List
,Set
or 1DArray
to create expressions with a dynamic number of operands. In that case, this operator becomes a binary operator that takes an interval, a list, a set or a 1D array as first operand and aLambdaFunction
as second operand. The operator will call the function on each value of the interval, list, set or 1D array and will find the maximum value among all the values returned by the function.
- Min¶
Minimum. N-ary arithmetic operator.
MIN(e1, e2, ..., eN)
is equal to the minimum value among all operandse1, e2, ..., eN
. This operator returns an integer if all the operands are booleans or integers, and a double as soon as one operand is a double.With collections (lists, sets), 1D arrays or intervals
This operator can also be used with intervals,
List
,Set
or 1DArray
to create expressions with a dynamic number of operands. In that case, this operator becomes a binary operator that takes an interval, a list, a set or a 1D array as first operand and aLambdaFunction
as second operand. The operator will call the function on each value of the interval, list, set or 1D array and will find the minimum value among all the values returned by the function.
- Eq¶
Equal. Binary relational operator.
EQ(a,b) = 1
ifa == b
, and0
otherwise. This operator returns a boolean.
- Neq¶
Not equal to. Binary relational operator.
NEQ(a,b) = 1
ifa != b
, and0
otherwise. This operator returns a boolean.
- Geq¶
Greater than or equal to. Binary relational operator.
GEQ(a,b) = 1
ifa >= b
, and0
otherwise. This operator returns a boolean.
- Leq¶
Lower than or equal to. Binary relational operator.
LEQ(a,b) = 1
ifa <= b
, and0
otherwise. This operator returns a boolean.
- Gt¶
Strictly greater than. Binary relational operator.
GT(a,b) = 1
ifa > b
, and0
otherwise. Can be used to compare two intervals, in that caseGT(a, b) = 1
ifstart(a) >= end(b)
, and0
otherwise. Undefined ifa
orb
is void. This operator returns a boolean.
- Lt¶
Strictly lower than. Binary relational operator.
LT(a, b) = 1
ifa < b
, and0
otherwise. Can be used to compare two intervals, in that caseLT(a, b) = 1
ifend(a) <= start(b)
, and0
otherwise. Undefined ifa
orb
is void. This operator returns a boolean.
- If¶
If-Then-Else. Ternary conditional operator.
IF(a, b, c)
is equal tob
ifa = 1
, andc
otherwise. The first operand must be a boolean (that is, equal to 0 or 1). This operator returns a boolean if the three operands are booleans, an integer if the second and third operands are integers, and a double if the second or the third operand is a double.
- Not¶
Not. Unary logical operator.
NOT(a) = 1 - a
. The operand must be boolean (that is, equal to 0 or 1). This operator returns a boolean.
- And¶
And. N-ary logical operator.
AND(e1, e2, ..., eN)
is equal to 1 (true) if all the operandse1, e2, ..., eN
are 1, and 0 otherwise. All the operands must be boolean (that is, equal to 0 or 1). This operator returns a boolean.With collections (lists, sets), 1D arrays or intervals
This operator can also be used with intervals,
List
,Set
or 1DArray
to create expressions with a dynamic number of operands. In that case, this operator becomes a binary operator that takes an interval, a list, a set or a 1D array as first operand and aLambdaFunction
as second operand. The operator will call the function on each value of the interval, list, set or 1D array and will return 1 if all the values returned by the function are 1 and 0 otherwise.
- Or¶
Or. N-ary logical operator.
OR(e1, e2, ..., eN)
is equal to 0 (false) if all operandse1, e2, ..., eN
are 0, and 1 otherwise. All the operands must be boolean (that is, equal to 0 or 1). This operator returns a boolean.With collections (lists, sets), 1D arrays or intervals
This operator can also be used with intervals,
List
,Set
or 1DArray
to create expressions with a dynamic number of operands. In that case, this operator becomes a binary operator that takes an interval, a list, a set or a 1D array as first operand and aLambdaFunction
as second operand. The operator will call the function on each value of the interval, list, set or 1D array and will return 0 if all the values returned by the function are 0 and 1 otherwise.
- Xor¶
Exclusive or (also called “xor”). N-ary logical operator.
XOR(e1, e2, ..., eN)
is equal to 0 if the number of operands with value 1 amonge1, e2, ..., eN
is even, and 1 otherwise. Remarkable case:XOR(a,b) = 1
ifa == b
, and0
otherwise. All the operands must be boolean (that is, equal to 0 or 1). This operator returns a boolean.With collections (lists, sets), 1D arrays or intervals
This operator can also be used with intervals,
List
,Set
or 1DArray
to create expressions with a dynamic number of operands. In that case, this operator becomes a binary operator that takes an interval, a list, a set or a 1D array as first operand and aLambdaFunction
as second operand. The operator will call the function on each value of the interval, list, set or 1D array and will return 0 if the number of value 1 returned by the function is even, and 1 otherwise.
- Abs¶
Absolute value. Unary arithmetic operator.
ABS(e) = e >= 0 ? e : -e
. This operator returns an integer if the operand is a boolean or an integer, and a double otherwise.
- Dist¶
Distance between two numbers. Binary arithmetic operator.
DIST(a,b) = ABS(a-b)
. This operator returns an integer if the two operands are booleans or integers, and a double as soon as one of the operand is a double.
- Div¶
Division. Binary arithmetic operator. This operator always returns a double. Note that until version 4.0, the division was an integer division if both operands were integers.
- Mod¶
Modulo (remainder of the integer division). Binary arithmetic operator.
MOD(a, b) = r
such thata = q * b + r
withq
,r
integers, wherer
,a
have the same sign and|r| < |b|
. The operands must be integers or booleans. This operator returns an integer.
- Array¶
Array. An array is a collection of elements. Indexes begin at 0. It could be used with operators like
At
orScalar
. An array doesn’t have a value by itself, but can contain operands of type boolean, integer, double, array (for multi-dimensional arrays) or collection (list, set). In the latter case, the collections must share the same domain and same type (either list or set). All the elements of an array must be of the same type.With intervals or lists
This operator can also be used with intervals or lists to create an array with a dynamic number of elements. In that case, this operator becomes a binary operator that takes an interval or a list as first operand and a
LambdaFunction
as second operand. The operator will call the function on each value of the interval or the list and the returned values will be used to populate the array.- Since
2.1
- At¶
Returns the element at specific coordinates of an array or a list.
For arrays
The first operand must be the array and the other operands must be the coordinates of the element to get. The number of coordinates depends on the dimension of the array. Thus AT(myArray, i) returns the i element of the one-dimensional array myArray. This operator returns a boolean, an integer or a double according to the type of the operands in the array. If one of the specified coordinate is out of range, the evaluation of the expression will fail.
For lists
The first operand must be the list and the second operand must be the index of the element to get. If the index is out of range (index < 0 or index > count(list)), the evaluation of the expression will not fail but will return -1.
- Since
2.1
- Scalar¶
Scalar product.
SCALAR(a, x) = sum(a[i]*x[i])
wherea
andx
are two one-dimensional arrays. This operator returns an integer or a double according to the type of the operands in the arrays.- Since
2.1
- Ceil¶
Ceil. Unary arithmetic operator. Returns a value rounded to the next highest integer. The operand can be a boolean, an integer or a double. This operator returns an integer.
- Since
3.0
- Floor¶
Floor. Unary arithmetic operator. Returns a value rounded to the next lowest integer. The operand can be a boolean, an integer or a double. This operator returns an integer.
- Since
3.0
- Round¶
Round. Unary arithmetic operator. Returns a value rounded to the nearest integer. The operand can be a boolean, an integer or a double. This operator returns an integer.
- Since
3.0
- Sqrt¶
Square root. Unary arithmetic operator. The operand can be a boolean, an integer or a double. This operator returns a double.
- Since
3.0
- Log¶
Natural logarithm (base-e). Unary arithmetic operator. The operand can be a boolean, an integer or a double. This operator returns a double.
- Since
3.0
- Exp¶
Base-e exponential. Unary arithmetic operator. The operand can be a boolean, an integer or a double. This operator returns a double.
- Since
3.0
- Pow¶
Power operator.
POW(x, y)
is equals to the value ofx
to the power ofy
. The operands can be booleans, integers or doubles. This operator returns a double.- Since
3.0
- Cos¶
Cosine. Unary arithmetic operator. The operand can be a boolean, an integer or a double. This operator returns a double.
- Since
3.0
- Sin¶
Sine. Unary arithmetic operator. The operand can be a boolean, an integer or a double. This operator returns a double.
- Since
3.0
- Tan¶
Tangent. Unary arithmetic operator. The operand can be a boolean, an integer or a double. This operator returns a double.
- Since
3.0
- Int¶
Integer decision variable. Operator with two operands that represent the lower bound and the upper bound of the decision (domain
[lb, ub]
). The bounds must be integer constants.- Since
5.0
- Piecewise¶
Piecewise-linear function operator. The piecewise linear function is defined by two arrays of numbers giving the breakpoints of the function. This operator has exactly 3 operands: The first two operands must be two arrays of equal sizes (necessarily larger or equal to 2). These arrays must contain constant numbers (integers or doubles). The first array must contain numbers in ascending order. The third operand must be an integer or a double expression. The evaluation of the piecewise will fail if the value of the third operand is strictly smaller that the first element of the first array, or strictly larger than the last element of the first array. This operator returns a double.
PIECEWISE(x,y,z)
returns the image of z by the function defined by geometric points(x[0],y[0]), (x[1],y[1]), ..., (x[n-1],y[n-1])
, For instancePIECEWISE(ARRAY(0, 50, 100), ARRAY(0, 10, 100), 75)
returns55
.Discontinuities are allowed in the definition of the function, that is to say that two geometric points can share the same x-coordinate. By convention the value taken by the function at such a discontinuous point is the one associated to the last occurrence of this x-coordinate in array x. For instance
PIECEWISE(ARRAY(0, 50, 50, 100), ARRAY(0, 0.1, 0.9, 1), 50)
returns0.9
;- Since
5.0
- List¶
A list is an ordered collection of integers within a domain
[0, n-1]
wheren
is the unique argument of this operator. Mathematically a list is a permutation of a subset of[0, n-1]
. This operator takes exactly one operand: a strictly positive integer constant. All values in the list will be pairwise different, non negative and strictly smaller that this number.The elements of the list can be accessed individually with the operator
At
.- Since
5.5
- Count¶
The number of elements in an array, a collection or an interval. This operator takes exactly one argument of type array, collection or interval and returns an integer.
- Since
5.5
- IndexOf¶
The index of a value in a list (-1 if the value is not in the list). This operator takes exactly two arguments: the first one is a list, the second one is an integer expression.
- Since
5.5
- Partition¶
Partition. N-ary logical operator.
PARTITION(c1, c2, ..., cN)
is true if all lists or setsc1, c2, ..., cN
form a partition of their common domain.cAll the operands must be collections of the same type (either list or set) and on the same range. These collections can be stored in a LSArray that will be passed as argument of the partition:PARTITION(array(c1, c2, ..., cN))
.- Since
5.5
- Disjoint¶
Disjoint. N-ary logical operator.
DISJOINT(c1, c2, ..., cN)
is true if all lists or setsc1, c2, ..., cN
are pairwise disjoint. All the operands must be collections of the same type (either list or set) and on the same range. These collections can be stored in a LSArray that will be passed as argument of the disjoint:DISJOINT(array(c1, c2, ..., cN))
.- Since
5.5
- Cover¶
Cover. N-ary logical operator.
COVER(c1, c2, ..., cN)
is true if all values in the domain are at least in one list or setc1, c2, ..., cN
. All the operands must be collections of the same type (either list or set) and on the same range. These collections can be stored in a LSArray that will be passed as argument of the cover:COVER(array(c1, c2, ..., cN))
.- Since
10.5
- Find¶
Find.
find(a, v)
returns the position of the collection in the arraya
that contains the valuev
. If the value is not in any collections of the array, it returns -1. This operator takes exactly two arguments: the first one is anArray
of collections, the second one is the value searched. All the collections of the array must be of the same type and on the same range.- Since
10.5
- ExternalFunction¶
External function. External functions are used to compute the value of expressions from external functions written with your favorite programming language. External functions are created with the dedicated methods
LSModel.CreateIntExternalFunction
orLSModel.CreateDoubleExternalFunction
.- See
- See
- Since
9.5
- Call¶
Call a particular function. The first operand must be a function (like
ExternalFunction
orLambdaFunction
). The other operands are passed to the function as arguments. If the function is not an external function, the number of operands must match the number of arguments of the function.- Since
6.0
- LambdaFunction¶
Lambda function. Lambda functions are created with the dedicated method
LSModel.CreateLambdaFunction
.- Since
9.5
- Argument¶
Argument of a function. Arguments are automatically and implicitely created when you create a function with method
LSModel.CreateLambdaFunction
.- Since
7.0
- Range¶
Range expression. This operator takes exactly two integer operands. The first one is the lower bound (inclusive), the second one is the upper bound (exclusive).
A range has an interval value and can be used with N-ary operators like
Sum
,Prod
,Min
,Max
,Or
,And
,Xor
orArray
to create expressions that have a dynamic number of operands.- Since
7.0
- Contains¶
Contains.
contains(expr, v)
is true if and only if the expressionexpr
contains the valuev
. This operator takes exactly two arguments: the first one is a collection (List
orSet
), an interval or anArray
of collections, the second one is the integer expression searched. Ifexpr
is an array, all its collections must be of the same type and on the same range.- Since
7.5
- Set¶
A set is an unordered collection of integers within a range [0, n-1] where n is the unique argument of this operator. This operator takes exactly one operand: a strictly positive integer constant. All values in the set will be pairwise different, non negative and strictly smaller that this number. Contrary to the
List
operator, elements in a set are not ordered and cannot be indexed withAt
. Sets can only be manipulated with lambdas and n-ary operators likeSum
,Min
,And
, …- Since
8.0
- Sort¶
Sort.
Sort(a)
return the inputArray
a
sorted in ascending order. This operator returns an array of integers if the input array is solely composed of booleans or integers, and an array of doubles as soon as the input array contains a double.This operator can also be used with an optional
LambdaFunction
as second argumentSort(a, key)
. In that case the operator will sort the array in ascending order based on the values returned by the lambda function. The sort operator guarantees that the order of elements having the same key is preserved.- Since
11.0
- Interval¶
Interval decision variable. Operator with two integer constant operands that represent the min start and the max end of the decision. The interval is included in
[minStart, maxEnd)
. Its start is inclusive and its end is exclusive.- Since
12.0
- Start¶
The start of a non-void interval. This operator takes exactly one argument of type interval and returns an integer.
- Since
12.0
- End¶
The end of a non-void interval. This operator takes exactly one argument of type interval and returns an integer.
- Since
12.0
- Length¶
The length of a non-void interval. This operator takes exactly one argument of type interval and returns an integer. The length of an interval is equivalent to
end(interval) - start(interval).
It differs from the count on void intervals since the length of a void interval is undefined whereas the count of a void interval is 0.- Since
12.0
- Distinct¶
Returns the distinct values of the elements of an array, collection or interval. This operator accepts one or two operands. With one operand, the operator takes an array and returns the unordered set of distinct values in the array. With two operands, the operator takes a collection (set or list), range or interval as first operand and a
LambdaFunction
as second operand. The operator calls the function on each element of the iterable and returns the unordered set of distinct values among all the values returned by the function.- Since
12.5
- Intersection¶
Returns the intersection between an array/collection and an array/collection. This operator accepts two operands. The operator takes a collection (set or list), or an array (constant or not) as its first and second operand. The operator returns the unordered set of the values present in both operands.
- Since
12.5