LSExpression Class¶

class LSExpression¶

Mathematical modeling expression. Expressions are used to build the mathematical optimization model associated to LocalSolver. An expression is composed of an operator (which corresponds to its type) and its operands (which are other expressions of the model).

See: LSModel
See: LSOperator

Summary¶

Functions¶
`getOperator`	Gets the operator of this expression.
`getIndex`	Gets the index of this expression in the model.
`isConstant`	Returns true if this expression is typed as constant in the model, false otherwise.
`isDecision`	Returns true if this expression is typed as decision in the model, false otherwise.
`isConstraint`	Returns true if this expression is tagged as constraint in the model, false otherwise.
`isObjective`	Returns true if this expression is tagged as objective in the model, false otherwise.
`isDouble`	Returns true if this expression is a double, false otherwise.
`isInt`	Returns true if this expression is an integer, false otherwise.
`isBool`	Returns true if this expression is a boolean (ie 0 or 1), false otherwise.
`isInterval`	Returns true if this expression is an interval, false otherwise.
`isArray`	Returns true if this expression is an array, false otherwise.
`isCollection`	Returns true if this expression is a collection (list or set), false otherwise.
`isFunction`	Returns true if this expression is a function, false otherwise.
`addOperand`	Adds the given operand to this expression.
`addOperand`	Add the given constant operand to this expression.
`addOperand`	Add the given constant operand to this expression.
`addOperand`	Add the given constant operand to this expression.
`addOperands`	Add the given operands to this expression.
`addOperands`	Add the given operands to this expression.
`getOperand`	Gets the operand with the given index.
`setOperand`	Replaces the operand of the given index.
`setOperand`	Replaces the operand of the given index.
`setOperand`	Replaces the operand of the given index.
`setOperand`	Replaces the operand of the given index.
`getNbOperands`	Gets the number of operands of this expression.
`setValue`	Sets the value of this expression in the current solution found by the solver.
`setValue`	Sets the value of this expression in the current solution found by the solver.
`setValue`	Sets the value of this expression in the current solution found by the solver.
`setIntValue`	Sets the value of this expression in the current solution found by the solver.
`setDoubleValue`	Sets the value of this expression in the current solution found by the solver.
`setIntervalValue`	Sets the value of this expression in the current solution found by the solver.
`getValue`	Gets the value of this expression in the best solution found by the solver.
`getIntValue`	Gets the value of this expression in the best solution found by the solver.
`getDoubleValue`	Gets the value of this expression in the best solution found by the solver.
`getIntervalValue`	Gets the value of this expression in the best solution found by the solver.
`getCollectionValue`	Gets the value of this expression in the best solution found by the solver.
`getArrayValue`	Gets the value of this expression in the best solution found by the solver.
`getExternalContext`	Gets the external function context of this expression.
`isViolated`	Returns true if the given expression is violated in the best solution found by the solver.
`isUndefined`	Returns true if the given expression has an undefined value in the best solution found by the solver.
`setName`	Sets the name of this expression.
`isNamed`	Returns true if this expression has a name, and false otherwise.
`getName`	Gets the name of this expression or the empty string if no name has been set.
`toString`	Returns a string representation of this expression.

Overloaded operators¶
`operator+`	Creates a new O_Sum expression.
`operator-`	Creates a new O_Sub expression.
`operator*`	Creates a new O_Prod expression.
`operator%`	Creates a new O_Mod expression.
`operator/`	Creates a new O_Div expression.
`operator!`	Creates a new O_Not expression.
`operator&&`	Creates a new O_And expression.
`operator\|\|`	Creates a new O_Or expression.
`operator^`	Creates a new O_Xor expression.
`operator==`	Creates a new O_Eq expression.
`operator!=`	Creates a new O_Neq expression.
`operator>=`	Creates a new O_Geq expression.
`operator<=`	Creates a new O_Leq expression.
`operator>`	Creates a new O_Gt expression.
`operator<`	Creates a new O_Lt expression.
`operator[]`	Creates a new O_At expression.
`operator()`	Creates a O_Call expression with the given operands as arguments.

Functions¶

LSOperator LSExpression::getOperator() const¶

Gets the operator of this expression.

Returns: Operator.

int LSExpression::getIndex() const¶

Gets the index of this expression in the model.

Returns: Index in the model.

bool LSExpression::isConstant() const¶

Returns true if this expression is typed as constant in the model, false otherwise.

Returns: True if typed as constant.

bool LSExpression::isDecision() const¶

Returns true if this expression is typed as decision in the model, false otherwise.

Returns: True if typed as decision.

bool LSExpression::isConstraint() const¶

Returns true if this expression is tagged as constraint in the model, false otherwise.

Returns: True if tagged as constraint.

bool LSExpression::isObjective() const¶

Returns true if this expression is tagged as objective in the model, false otherwise.

Returns: True if tagged as objective.

bool LSExpression::isDouble() const¶

Returns true if this expression is a double, false otherwise. Only allowed in states S_Paused or S_Stopped.

Returns: True if the expression is a double.
Since: 3.0

bool LSExpression::isInt() const¶

Returns true if this expression is an integer, false otherwise. Only allowed in states S_Paused or S_Stopped. Note that a boolean is also an integer.

Returns: True if the expression is an integer.
Since: 3.0

bool LSExpression::isBool() const¶

Returns true if this expression is a boolean (ie 0 or 1), false otherwise. Only allowed in states S_Paused or S_Stopped.

Returns: True if the expression is a boolean.
Since: 3.0

bool LSExpression::isInterval() const¶

Returns true if this expression is an interval, false otherwise. Only allowed in states S_Paused or S_Stopped.

Returns: True if the expression is an interval.
Since: 12.0

bool LSExpression::isArray() const¶

Returns true if this expression is an array, false otherwise. Only allowed in states S_Paused or S_Stopped.

Returns: True if the expression is an array.
Since: 3.1

bool LSExpression::isCollection() const¶

Returns true if this expression is a collection (list or set), false otherwise. Only allowed in states S_Paused or S_Stopped.

Returns: True if the expression is a collection.
Since: 5.5

bool LSExpression::isFunction() const¶

Returns true if this expression is a function, false otherwise. Only allowed in states S_Paused or S_Stopped.

Returns: True if the expression is a function.
Since: 6.0

void LSExpression::addOperand(const LSExpression &operand)¶

Adds the given operand to this expression. Only allowed in state S_Modeling.

Parameters: operand – Operand to add.

void LSExpression::addOperand(int constant)¶

Add the given constant operand to this expression. Only allowed in state S_Modeling.

Parameters: constant – Constant operand to add.

void LSExpression::addOperand(lsint constant)¶

Add the given constant operand to this expression. Only allowed in state S_Modeling.

Parameters: constant – Constant operand to add.

void LSExpression::addOperand(lsdouble constant)¶

Add the given constant operand to this expression. Only allowed in state S_Modeling.

Parameters: constant – Constant operand to add.
Since: 3.0

template<typename ...TN> void LSExpression::addOperands(TN... operands)¶

Add the given operands to this expression. Only allowed in state S_Modeling.

The operands can be doubles, integers or previously declared LSExpressions. It is also possible to use this method with iterators. In that case, you have to call this method with 2 arguments exactly that must be iterators of the same type, pointing respectively to the initial and final positions of the operands.

Parameters

TN – types of the operands to add. Types allowed: constant types, LSExpression or iterators.
operands – operands.

template<typename T0, typename T1> void LSExpression::addOperands(T0 begin, T1 end)¶

Add the given operands to this expression. Only allowed in state S_Modeling.

Parameters

begin – iterator to the initial position of the operands to add.
end – iterator to the final position of the operands to add.

Since

5.5

LSExpression LSExpression::getOperand(int operandIndex) const¶

Gets the operand with the given index.

Parameters: operandIndex – Index of the operand.
Returns: Operand.

void LSExpression::setOperand(int operandIndex, const LSExpression &operand)¶

Replaces the operand of the given index.

Parameters

operandIndex – Index of the operand to change
operand – New operand

void LSExpression::setOperand(int operandIndex, int constant)¶

Replaces the operand of the given index.

Parameters

operandIndex – Index of the operand to change.
constant – New constant operand.

void LSExpression::setOperand(int operandIndex, lsint constant)¶

Replaces the operand of the given index.

Parameters

operandIndex – Index of the operand to change.
constant – New constant operand.

void LSExpression::setOperand(int operandIndex, lsdouble constant)¶

Replaces the operand of the given index.

Parameters

operandIndex – Index of the operand to change.
constant – New constant operand.

Since

3.0

int LSExpression::getNbOperands() const¶

Gets the number of operands of this expression.

Returns: Number of operands.

void LSExpression::setValue(lsint value)¶

Sets the value of this expression in the current solution found by the solver. Only allowed for decisions. Only allowed in state S_Stopped. Only allowed if this expression is an integer or a boolean. If the solver was not launched, this value will be used as an initial value for the decision. This method is a shortcut for LSSolution::setValue() and has the same behavior as setIntValue().

Parameters: value – Value assigned to this expression.
See: LSSolution::setValue()
See: LSExpression::isInt()
See: LSExpression::isBool()

void LSExpression::setValue(lsdouble value)¶

Sets the value of this expression in the current solution found by the solver. Only allowed for decisions. Only allowed in state S_Stopped. Only allowed if this expression is an integer or a boolean. If the solver was not launched, this value will be used as an initial value for the decision. This method is a shortcut for LSSolution::setDoubleValue() and has the same behavior as setDoubleValue().

Parameters: value – Value assigned to this expression.
See: LSSolution::setValue()
See: LSExpression::isDouble()

void LSExpression::setValue(LSInterval value)¶

Sets the value of this expression in the current solution found by the solver. Only allowed for decisions. Only allowed in state S_Stopped. Only allowed if this expression is an interval If the solver was not launched, this value will be used as an initial value for the decision. This method is a shortcut for LSSolution::setIntervalValue() and has the same behavior as setIntervalValue().

Parameters: value – Value assigned to this expression.
See: LSSolution::setValue()
See: LSExpression::isInterval()

void LSExpression::setIntValue(lsint value)¶

Sets the value of this expression in the current solution found by the solver. Only allowed for decisions. Only allowed in state S_Stopped. Only allowed if this expression is an integer or a boolean. If the solver was not launched, this value will be used as an initial value for the decision. This method is a shortcut for LSSolution::setIntValue().

Parameters: value – Value assigned to this expression.
See: LSSolution::setIntValue()
See: LSExpression::isInt()
See: LSExpression::isBool()
Since: 3.0

void LSExpression::setDoubleValue(lsdouble value)¶

Sets the value of this expression in the current solution found by the solver. Only allowed for decisions. Only allowed in state S_Stopped. Only allowed if this expression is a double. If the solver was not launched, this value will be used as an initial value for the decision. This method is a shortcut for LSSolution::setDoubleValue().

Parameters: value – Value assigned to this expression.
See: LSSolution::setDoubleValue()
See: LSExpression::isDouble()
Since: 3.0

void LSExpression::setIntervalValue(LSInterval value)¶

Sets the value of this expression in the current solution found by the solver. Only allowed for decisions. Only allowed in state S_Stopped. Only allowed if this expression is an interval. If the solver was not launched, this value will be used as an initial value for the decision. This method is a shortcut for LSSolution::setIntervalValue().

Parameters: value – Value assigned to this expression.
See: LSSolution::setIntervalValue()
See: LSExpression::isInterval()
Since: 12.0

lsint LSExpression::getValue() const¶

Gets the value of this expression in the best solution found by the solver. Only allowed in states S_Paused or S_Stopped. Only allowed if this expression is an integer or a boolean. This method is a shortcut for LSSolution::getValue().

Returns: Value in the best solution.
See: LSSolution::getValue()
See: LSExpression::isInt()
See: LSExpression::isBool()

lsint LSExpression::getIntValue() const¶

Gets the value of this expression in the best solution found by the solver. Only allowed in states S_Paused or S_Stopped. Only allowed if this expression is an integer or a boolean. This method is a shortcut for LSSolution::getIntValue().

Returns: Value in the best solution.
See: LSSolution::getIntValue()
See: LSExpression::isInt()
See: LSExpression::isBool()
Since: 3.0

lsdouble LSExpression::getDoubleValue() const¶

Gets the value of this expression in the best solution found by the solver. Only allowed in states S_Paused or S_Stopped. Only allowed if this expression is a double. This method is a shortcut for LSSolution::getDoubleValue().

Returns: Value in the best solution.
See: LSSolution::getDoubleValue()
See: LSExpression::isDouble()
Since: 3.0

LSInterval LSExpression::getIntervalValue() const¶

Gets the value of this expression in the best solution found by the solver. Only allowed in states S_Paused or S_Stopped. Only allowed if this expression is an interval. This method is a shortcut for LSSolution::getIntervalValue().

Returns: Value in the best solution.
See: LSSolution::getIntervalValue()
See: LSExpression::isInterval()
Since: 12.0

LSCollection LSExpression::getCollectionValue() const¶

Gets the value of this expression in the best solution found by the solver. Only allowed in states S_Paused or S_Stopped. Only allowed if this expression is a collection (list or set). This method is a shortcut for LSSolution::getCollectionValue().

Returns: Value in the best solution.
See: LSExpression::isCollection()
See: LSSolution::getCollectionValue()
Since: 5.5

LSArray LSExpression::getArrayValue() const¶

Gets the value of this expression in the best solution found by the solver. Only allowed in states S_Paused or S_Stopped. Only allowed if this expression is an array. This method is a shortcut for LSSolution::getArrayValue().

Returns: Value in the best solution.
See: LSExpression::isArray()
See: LSSolution::getArrayValue()
Since: 7.5

LSExternalContext LSExpression::getExternalContext() const¶

Gets the external function context of this expression. Only allowed if this expression is an external function.

Returns: Context of the external function.
See: LSExternalContext
Since: 9.5

bool LSExpression::isViolated() const¶

Returns true if the given expression is violated in the best solution found by the solver. An expression can be violated in 3 cases:

it is a constraint and its value is 0
it is a double objective and its value is NaN (Not a Number)
it is an integer or boolean with no valid value (arithmetic or out of bounds exception).

Note that only constraints and objectives can be violated. Other expression can have undefined value provided that it does not impact a constraint or objective.

Only allowed in states S_Paused or S_Stopped. This method is a shortcut for LSSolution::isViolated().

Returns: True if this expression is violated in the best solution.
Since: 5.5
See: LSExpression::isUndefined()

bool LSExpression::isUndefined() const¶

Returns true if the given expression has an undefined value in the best solution found by the solver. An expression can be undefined in 4 cases:

It is a double and its value is NaN (Not a Number).
It is an integer or boolean with no valid value (arithmetic or out of bounds exception).
It is an interval with at least one undefined bound.
It is the result of any ill-defined operation (at with out of bounds index or operations on undefined values for instance).

Only allowed in states S_Paused or S_Stopped. This method is a shortcut for LSSolution::isUndefined().

Returns: True if this expression has an undefined value in the best solution.
Since: 7.0

void LSExpression::setName(const std::string &name)¶

Sets the name of this expression. Only allowed in state S_Modeling. The name cannot be empty. Two operators of the model cannot share the same name. Useful for debugging or logging purposes.

Parameters: name – Name.

bool LSExpression::isNamed() const¶

Returns true if this expression has a name, and false otherwise.

Returns: True if named.

std::string LSExpression::getName() const¶

Gets the name of this expression or the empty string if no name has been set.

Returns: Name.

std::string LSExpression::toString() const¶

Returns a string representation of this expression. This representation provides the index of the expression, its type, and its name (if any). Useful for debugging or logging purposes.

Returns: String representation.

Overloaded operators¶

template<typename T> LSExpression LSExpression::operator+(T operand)¶

Creates a new O_Sum expression. It is a shortcut for model.createExpression(O_Sum, this, operand).

Parameters: operand – Operand. Can be an LSExpression, an integer or a double.
Returns: A new O_Sum expression.

template<typename T> LSExpression LSExpression::operator-(T operand)¶

Creates a new O_Sub expression. It is a shortcut for model.createExpression(O_Sub, this, operand).

Parameters: operand – Operand. Can be an LSExpression, an integer or a double.
Returns: A new O_Sub expression.

template<typename T> LSExpression LSExpression::operator*(T operand)¶

Creates a new O_Prod expression. It is a shortcut for model.createExpression(O_Prod, this, operand).

Parameters: operand – Operand. Can be an LSExpression, an integer or a double.
Returns: A new O_Prod expression.

template<typename T> LSExpression LSExpression::operator%(T operand)¶

Creates a new O_Mod expression. It is a shortcut for model.createExpression(O_Mod, this, operand).

Parameters: operand – Operand. Can be an LSExpression or an integer.
Returns: A new O_Mod expression.

template<typename T> LSExpression LSExpression::operator/(T operand)¶

Creates a new O_Div expression. It is a shortcut for model.createExpression(O_Div, this, operand).

Parameters: operand – Operand. Can be an LSExpression, an integer or a double.
Returns: A new O_Div expression.

LSExpression LSExpression::operator!()¶

Creates a new O_Not expression. It is a shortcut for model.createExpression(O_Not, this).

Returns: A new O_Not expression.

template<typename T> LSExpression LSExpression::operator&&(T operand)¶

Creates a new O_And expression. It is a shortcut for model.createExpression(O_And, this, operand).

Parameters: operand – Operand. Can be an LSExpression or a boolean.
Returns: A new O_And expression.

template<typename T> LSExpression LSExpression::operator||(T operand)¶

Creates a new O_Or expression. It is a shortcut for model.createExpression(O_Or, this, operand).

Parameters: operand – Operand. Can be an LSExpression or a boolean.
Returns: A new O_Or expression.

template<typename T> LSExpression LSExpression::operator^(T operand)¶

Creates a new O_Xor expression. It is a shortcut for model.createExpression(O_Xor, this, operand).

Parameters: operand – Operand. Can be an LSExpression or a boolean.
Returns: A new O_Xor expression.

template<typename T> LSExpression LSExpression::operator==(T operand)¶

Creates a new O_Eq expression. It is a shortcut for model.createExpression(O_Eq, this, operand).

Parameters: operand – Operand. Can be an LSExpression, an integer or a double.
Returns: A new O_Eq expression.

template<typename T> LSExpression LSExpression::operator!=(T operand)¶

Creates a new O_Neq expression. It is a shortcut for model.createExpression(O_Neq, this, operand).

Parameters: operand – Operand. Can be an LSExpression, an integer or a double.
Returns: A new O_Neq expression.

template<typename T> LSExpression LSExpression::operator>=(T operand)¶

Creates a new O_Geq expression. It is a shortcut for model.createExpression(O_Geq, this, operand).

Parameters: operand – Operand. Can be an LSExpression, an integer or a double.
Returns: A new O_Geq expression.

template<typename T> LSExpression LSExpression::operator<=(T operand)¶

Creates a new O_Leq expression. It is a shortcut for model.createExpression(O_Leq, this, operand).

Parameters: operand – Operand. Can be an LSExpression, an integer or a double.
Returns: A new O_Leq expression.

template<typename T> LSExpression LSExpression::operator>(T operand)¶

Creates a new O_Gt expression. It is a shortcut for model.createExpression(O_Gt, this, operand).

Parameters: operand – Operand. Can be an LSExpression, an integer or a double.
Returns: A new O_Gt expression.

template<typename T> LSExpression LSExpression::operator<(T operand)¶

Creates a new O_Lt expression. It is a shortcut for model.createExpression(O_Lt, this, operand).

Parameters: operand – Operand. Can be an LSExpression, an integer or a double.
Returns: A new O_Lt expression.

template<typename T> LSExpression LSExpression::operator[](T operand)¶

Creates a new O_At expression. It is a shortcut for model.createExpression(O_At, this, operand).

Parameters: operand – Operand. Can be an LSExpression, an integer or a double.
Returns: A new O_At expression.

template<typename ...TN> LSExpression LSExpression::operator()(TN... operands)¶

Creates a O_Call expression with the given operands as arguments. It is a shortcut for model.createExpression(O_Call, this, operands).

Parameters

TN – types of the operands to add. Types allowed: constant types, LSExpression or iterators.
operands – operands.