HxModel Class¶

class HxModel¶

Mathematical optimization model. A model is composed of expressions (some of which are decisions), organized as a tree. Then, some expressions of the model can be constrained or optimized. Once your optimization model is created and closed, the optimizer can be launched to resolve it. Note that you cannot modify a model which has been closed: you must reopen it (with open()) or instantiate another Hexaly Optimizer environment to optimize another model.

See:: HxExpression
See:: HxOperator

Summary¶

Functions¶
`createConstant`	Creates a constant expression representing the given value.
`createConstant`	Creates a constant expression representing the given value.
`createExpression`	Creates an expression of the given type, with the given ordered operands.
`createExternalFunction`	Creates an integer external function.
`createExternalFunction`	Creates a double external function.
`createExternalFunction`	Creates an integer array external function.
`createExternalFunction`	Creates a double array external function.
`createExternalFunction`	Creates an external function.
`createExternalFunction`	Creates an external function.
`createLambdaFunction`	Creates a lambda function.
`boolVar`	Creates a boolean decision.
`floatVar`	Creates a float decision.
`intVar`	Creates an integer decision.
`intervalVar`	Creates an interval decision included in [minStart, maxEnd).
`hull`	Creates a hull expression.
`hull`	Creates a hull expression.
`start`	Creates a start expression.
`end`	Creates an end expression.
`length`	Creates a length expression.
`sum`	Creates a sum expression.
`sub`	Creates a substraction expression.
`call`	Creates a call expression.
`prod`	Creates a product expression.
`max`	Creates a maximum expression.
`min`	Creates a minimum expression.
`or_`	Creates a OR expression.
`and_`	Creates an AND expression.
`xor_`	Creates a XOR expression.
`not_`	Creates a NOT expression.
`eq`	Creates an equality expression.
`neq`	Creates a disequality expression.
`geq`	Creates an inequality expression greater than or equal to.
`leq`	Creates an inequality expression less than or equal to.
`gt`	Creates an inequality expression greater than.
`lt`	Creates an inequality expression less than.
`iif`	Creates a ternary conditional expression.
`abs`	Creates an absolute value expression.
`dist`	Creates a distance expression.
`div`	Creates a division expression.
`mod`	Creates a modulo expression.
`array`	Creates an array expression.
`stepArray`	Creates an step array expression.
`at`	Creates an AT expression for N-dimensional array.
`scalar`	Creates an expression for the scalar product between two arrays.
`ceil`	Creates a ceil expression.
`floor`	Creates a floor expression.
`round`	Creates a rounding expression.
`sqrt`	Creates a square root expression.
`log`	Creates a log expression.
`exp`	Creates an exponential expression.
`pow`	Creates a power expression.
`cos`	Creates a cosine expression.
`sin`	Creates a sine expression.
`tan`	Creates a tangent expression.
`piecewise`	Creates a piecewise linear expression.
`listVar`	Creates a list decision with the given length.
`setVar`	Creates a set decision with the given length.
`count`	Creates a count expression.
`indexOf`	Creates an indexOf expression.
`distinct`	Creates a distinct expression.
`distinct`	Creates a distinct expression.
`intersection`	Creates an intersection expression.
`contains`	Creates a contains expression.
`partition`	Creates a partition expression.
`partition`	Creates a partition expression.
`disjoint`	Creates a disjoint expression.
`disjoint`	Creates a disjoint expression.
`cover`	Creates a cover expression.
`cover`	Creates a cover expression.
`find`	Creates a find expression.
`sort`	Creates a sort expression.
`sort`	Creates a sort expression.
`externalFunction`	Creates an external function expression.
`externalFunction`	Creates an external function expression.
`externalFunction`	Creates an external function expression.
`lambdaFunction`	Creates a lambda function expression.
`range`	Creates a range expression, where expr0 is the lower bound (inclusive) and expr1 is the upper bound (exclusive).
`getNbExpressions`	Gets the number of expressions added to this model.
`getExpression`	Gets the expression with the given index in this model.
`getExpression`	Gets the expression with the given name.
`getNbDecisions`	Gets the number of decisions in the model.
`getDecision`	Gets the decision with the given index.
`addConstraint`	Adds the given expression to the list of constraints.
`constraint`	Shortcut for addConstraint(expr).
`removeConstraint`	Removes the given expression from the list of constraints.
`removeConstraint`	Removes the constraint at the given position in the list of constraints.
`getNbConstraints`	Gets the number of constraints added to this model.
`getConstraint`	Gets the constraint with the given index.
`addObjective`	Adds the given expression to the list of objectives to optimize.
`minimize`	Shortcut for addObjective(expr, OD_Minimize).
`maximize`	Shortcut for addObjective(expr, OD_Maximize).
`removeObjective`	Removes the objective at the given position in the list of objectives.
`getNbObjectives`	Gets the number of objectives added to this model.
`getObjective`	Gets the objective with the given index.
`getObjectiveDirection`	Gets the direction of the objective with the given index.
`getNbOperands`	Gets the number of operands in the model.
`close`	Closes the model.
`open`	Reopens the model.
`isClosed`	Returns true if the model is closed, false otherwise.
`toString`	Returns a string representation of this model.

Functions¶

HxExpression HxModel::createConstant(hxint value)¶

Creates a constant expression representing the given value. Only allowed in state S_Modeling. Note that if a constant has been already created with the same value, this method can return the same expression, but it is not guaranteed. The exact behavior is implementation defined.

Parameters:: value – Value of the constant.
Returns:: Created constant expression.

HxExpression HxModel::createConstant(hxdouble value)¶

Creates a constant expression representing the given value. Only allowed in state S_Modeling. Note that if a constant has been already created with the same value, this method can return the same expression, but it is not guaranteed. The exact behavior is implementation defined.

Parameters:: value – Value of the constant
Returns:: Created constant expression.

template<typename ...TN> HxExpression createExpression(HxOperator op, TN... operands)¶

Creates an expression of the given type, with the given ordered operands. Only allowed in state S_Modeling. The operands can be doubles, integers or previously declared HxExpressions. It is also possible to use this method with iterators. In that case, you have to call this method with 2 operands 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, HxExpression or iterators.
op – Type of expression to create.
operands – Operands.

Returns:

Created expression.

HxExpression HxModel::createExternalFunction(HxExternalFunction<hxint> *func)¶

Creates an integer external function. The argument must be derived from HxExternalFunction. When the external function is called, the argument values will be made accessible to your function through the HxExternalArgumentValues.