LSOperator (LocalSolver 5.5 API)

java.lang.Object
- java.lang.Enum<LSOperator>
- - localsolver.LSOperator

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LSOperator>
```
public enum LSOperator
extends java.lang.Enum<LSOperator>
```
Mathematical operators available for modeling. These operators are used to type the expressions created in LocalSolver mathematical optimization model.

See Also:
LSModel, LSExpression

Enum Constant Summary

Enum Constants
Enum Constant and Description
`Abs` Absolute value.
`And` And.
`Array` Array.
`At` Returns the element of an array.
`Bool` Boolean decision.
`Ceil` Ceil.
`Const` Constant.
`Cos` Cosine.
`Count` The number of elements in a collection.
`Disjoint` Disjoint.
`Dist` Distance between two numbers.
`Div` Division.
`Eq` Equal.
`Exp` Base-e exponential.
`Float` Float decision.
`Floor` Floor.
`Geq` Greater than or equal to.
`Gt` Strictly greater than.
`If` If-Then-Else.
`IndexOf` The index of a value in a list (-1 if the value is not in the list).
`Int` Integer decision variable.
`Leq` Lower than or equal to.
`List` A list is an collection of integers within a range [0,n-1] where n is the unique argument of this operator.
`Log` Natural logarithm (base-e).
`Lt` Strictly lower than.
`Max` Maximum.
`Min` Minimum.
`Mod` Modulo (remainder of the integer division).
`Neq` Not equal to.
`Not` Not.
`Or` Or.
`Partition` Partition.
`Piecewise` Piecewise-linear function operator.
`Pow` Power operator.
`Prod` Product.
`Round` Round.
`Scalar` Scalar product.
`Sin` Sine.
`Sqrt` Square root.
`Sub` Substraction.
`Sum` Sum.
`Tan` Tangent.
`Xor` Exclusive or (also called "xor").

Method Summary

Methods
Modifier and Type	Method and Description
`static LSOperator`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static LSOperator[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - Bool
```
public static final LSOperator Bool
```
    Boolean decision. Decisional operator with no operand. Decision variable with domain {0,1}.
  - Float
```
public static final LSOperator Float
```
    Float decision. Decisional operator with two operands min and max. Decision variable with domain [min,max].
    
    Since:
    
    4.0
  - Const
```
public static final LSOperator Const
```
    Constant. Unary operator. Can be equal to any integer. Note that constants 0 or 1 are considered as boolean. Constants are implicitly created when passing integer arguments to LSModel.createExpression(LSOperator, long) or LSExpression.addOperand(long).
  - Sum
```
public static final LSOperator Sum
```
    Sum. N-ary arithmetic operator. SUM(e1,e2,...,eN) is equal to the sum of all operands e1,e2,...,eN. This operator returns an integer or a double according to the type of its operands.
  - Sub
```
public static final LSOperator Sub
```
    Substraction. Binary arithmetic operator. SUB(x, y) is equal to the value of x - y. This operator returns an integer or a double according to the type of its operands.
    
    Since:
    
    4.0
  - Prod
```
public static final LSOperator Prod
```
    Product. N-ary arithmetic operator. PROD(e1,e2,...,eN) is equal to the product of all operands e1,e2,...,eN. This operator returns an integer or a double according to the type of its operands.
  - Max
```
public static final LSOperator Max
```
    Maximum. N-ary arithmetic operator. MAX(e1,e2,...,eN) is equal to the maximum value among all operands e1,e2,...,eN. This operator returns an integer or a double according to the type of its operands.
  - Min
```
public static final LSOperator Min
```
    Minimum. N-ary arithmetic operator. MIN(e1,e2,...,eN) is equal to the minimum value among all operands e1,e2,...,eN. This operator returns an integer or a double according to the type of its operands.
  - Eq
```
public static final LSOperator Eq
```
    Equal. Binary relational operator. EQ(a,b) = 1 if a == b, and 0 otherwise. This operator returns a boolean.
  - Neq
```
public static final LSOperator Neq
```
    Not equal to. Binary relational operator. NEQ(a,b) = 1 if a != b, and 0 otherwise. This operator returns a boolean.
  - Geq
```
public static final LSOperator Geq
```
    Greater than or equal to. Binary relational operator. GEQ(a,b) = 1 if a >= b, and 0 otherwise. This operator returns a boolean.
  - Leq
```
public static final LSOperator Leq
```
    Lower than or equal to. Binary relational operator. LEQ(a,b) = 1 if a <= b, and 0 otherwise. This operator returns a boolean.
  - Gt
```
public static final LSOperator Gt
```
    Strictly greater than. Binary relational operator. GT(a,b) = 1 if a > b, and 0 otherwise. This operator returns a boolean.
  - Lt
```
public static final LSOperator Lt
```
    Strictly lower than. Binary relational operator. LQ(a, b) = 1 if a < b, and 0 otherwise. This operator returns a boolean.
  - If
```
public static final LSOperator If
```
    If-Then-Else. Ternary conditional operator. IF(a,b,c) is equal to b if a is true, and c otherwise. Note that the first operand must be a boolean (that is, equal to 0 or 1). This operator returns a boolean, an integer or a double according to the type of the second and third operands.
  - Not
```
public static final LSOperator Not
```
    Not. Unary logical operator. NOT(a) = 1 - a. Note that the operand must be boolean (that is, equal to 0 or 1). This operator returns a boolean.
  - And
```
public static final LSOperator And
```
    And. N-ary logical operator. AND(e1,e2,...,eN) is equal to 1 (true) if all operands e1,e2,...,eN are 1, and 0 otherwise. Note that all operands must be boolean (that is, equal to 0 or 1). This operator returns a boolean.
  - Or
```
public static final LSOperator Or
```
    Or. N-ary logical operator. OR(e1,e2,...,eN) is equal to 0 if all operands e1,e2,...,eN are 0, and 1 otherwise. Note that all operands must be boolean (that is, equal to 0 or 1). This operator returns a boolean.
  - Xor
```
public static final LSOperator 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 among e1,e2,...,eN is even, and 1 otherwise. Remarkable case: XOR(a,b) = 1 if a == b, and 0 otherwise. Note that all operands must be boolean (that is, equal to 0 or 1). This operator returns a boolean.
  - Abs
```
public static final LSOperator Abs
```
    Absolute value. Unary arithmetic operator. ABS(e) = e >= 0 ? e : -e. This operator returns an integer or a double according to the type of its operand.
  - Dist
```
public static final LSOperator Dist
```
    Distance between two numbers. Binary arithmetic operator. DIST(a,b) = ABS(a-b). This operator returns an integer or a double according to the type of its operands.
  - Div
```
public static final LSOperator 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
```
public static final LSOperator Mod
```
    Modulo (remainder of the integer division). Binary arithmetic operator. MOD(a,b) = r such that a = q * b + r with q, r integers and |r| < b. An error will be thrown if b equals 0 at an iteration of the search. Note that the operands must be integers. This operator returns an integer.
  - Array
```
public static final LSOperator Array
```
    Array. An array is a collection of elements. Indexes begin at 0. It could be used with operators like at or scalar. An array can contain operands of type double, integer or boolean. Note that an array cannot contain another array.
    
    Since:
    
    2.1
  - At
```
public static final LSOperator At
```
    Returns the element of an array. MyArray[i] returns the i element of the array MyArray. An error will be thrown if i is out of range. This operator returns a boolean, an integer or a double according to the type of the operands in the array.
    
    Since:
    
    2.1
  - Scalar
```
public static final LSOperator Scalar
```
    Scalar product. SCALAR(a, x) = sum(a[i]*x[i]) with a and x two arrays. This operator returns an integer or a double according to the type of the operands in the arrays.
    
    Since:
    
    2.1
  - Ceil
```
public static final LSOperator Ceil
```
    Ceil. Unary arithmetic operator. Returns a value rounded to the next highest integer. This operator returns an integer.
    
    Since:
    
    3.0
  - Floor
```
public static final LSOperator Floor
```
    Floor. Unary arithmetic operator. Returns a value rounded to the next lowest integer. This operator returns an integer.
    
    Since:
    
    3.0
  - Round
```
public static final LSOperator Round
```
    Round. Unary arithmetic operator. Returns a value rounded to the nearest integer. This operator returns an integer.
    
    Since:
    
    3.0
  - Sqrt
```
public static final LSOperator Sqrt
```
    Square root. Unary arithmetic operator. This operator returns a double.
    
    Since:
    
    3.0
  - Log
```
public static final LSOperator Log
```
    Natural logarithm (base-e). Unary arithmetic operator. This operator returns a double.
    
    Since:
    
    3.0
  - Exp
```
public static final LSOperator Exp
```
    Base-e exponential. Unary arithmetic operator. This operator returns a double.
    
    Since:
    
    3.0
  - Pow
```
public static final LSOperator Pow
```
    Power operator. POW(x, y) is equals to the value of x to the power of y. This operator returns a double.
    
    Since:
    
    3.0
  - Cos
```
public static final LSOperator Cos
```
    Cosine. Unary arithmetic operator. This operator returns a double.
    
    Since:
    
    3.0
  - Sin
```
public static final LSOperator Sin
```
    Sine. Unary arithmetic operator. This operator returns a double.
    
    Since:
    
    3.0
  - Tan
```
public static final LSOperator Tan
```
    Tangent. Unary arithmetic operator. This operator returns a double.
    
    Since:
    
    3.0
  - Int
```
public static final LSOperator Int
```
    Integer decision variable. Decisional operator with two operands min and max. Decision variable with domain [min,max].
    
    Since:
    
    5.0
  - Piecewise
```
public static final LSOperator 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 lengths (necessarily larger or equal to 2). These arrays must contain constant numbers (int or double). The first array must contain numbers in ascending order. The third operand must be an integer or double expression. An exception will be thrown if its value 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 instance piecewise({0,50,100},{0,10,100},75) returns 55. 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({0,50,50,100},{0,0.1,0.9,1},50) returns 0.9;
    
    Since:
    
    5.0
  - List
```
public static final LSOperator List
```
    A list is an collection of integers within a range [0,n-1] where n 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 parameter: a constant strictly positive integer. 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 with the at operator (-1 will be returned for indices beyond the number of elements in the list and for negative indices).
    
    Since:
    
    5.5
  - Count
```
public static final LSOperator Count
```
    The number of elements in a collection. This operator takes exactly one argument of type list.
    
    Since:
    
    5.5
  - IndexOf
```
public static final LSOperator 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
```
public static final LSOperator Partition
```
    Partition. N-ary logical operator. Partition(l1,l2,...,lN) is true if all lists l1,l2..lN form a partition of their common range. All parameters of this operator must be lists on the same range.
    
    Since:
    
    5.5
  - Disjoint
```
public static final LSOperator Disjoint
```
    Disjoint. N-ary logical operator. Disjoint(l1,l2,...,lN) is true if all lists l1,l2..lN are pairwise disjoint. All parameters of this operator must be lists on the same range.
    
    Since:
    
    5.5
- Method Detail
  - values
```
public static LSOperator[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (LSOperator c : LSOperator.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static LSOperator valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null

Enum LSOperator

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

Bool

Float

Const

Sum

Sub

Prod

Max

Min

Eq

Neq

Geq

Leq

Gt

Lt

If

Not

And

Or

Xor

Abs

Dist

Div

Mod

Array

At

Scalar

Ceil

Floor

Round

Sqrt

Log

Exp

Pow

Cos

Sin

Tan

Int

Piecewise

List

Count

IndexOf

Partition

Disjoint

Method Detail

values

valueOf