qiskit_addon_opt_mapper.problems.LinearConstraint¶

class LinearConstraint(optimization_problem, name, linear, sense, rhs)[source]¶

Representation of a linear constraint.

Init method.

Parameters:

optimization_problem (Any) – The parent optimization problem.
name (str) – The name of the constraint.
linear (ndarray | spmatrix | list[float] | dict[str | int, float]) – The coefficients specifying the linear constraint.
sense (ConstraintSense) – The sense of the constraint.
rhs (float) – The right-hand-side of the constraint.

__init__(optimization_problem, name, linear, sense, rhs)[source]¶

Init method.

Parameters:

optimization_problem (Any) – The parent optimization problem.
name (str) – The name of the constraint.
linear (ndarray | spmatrix | list[float] | dict[str | int, float]) – The coefficients specifying the linear constraint.
sense (ConstraintSense) – The sense of the constraint.
rhs (float) – The right-hand-side of the constraint.

Return type:

None

Methods

`__init__`(optimization_problem, name, linear, ...)	Init method.
`evaluate`(x)	Evaluate the left-hand-side of the constraint.

Attributes

`linear`	Returns the linear expression corresponding to the left-hand-side of the constraint.
`name`	Returns the name of the constraint.
`optimization_problem`	Returns the parent OptimizationProblem.
`rhs`	Returns the right-hand-side of the constraint.
`sense`	Returns the sense of the constraint.

evaluate(x)[source]¶

Evaluate the left-hand-side of the constraint.

Parameters:: x (ndarray | list | dict[int | str, float]) – The values of the variables to be evaluated.
Returns:: The left-hand-side of the constraint given the variable values.
Return type:: float

property linear: LinearExpression¶

Returns the linear expression corresponding to the left-hand-side of the constraint.

property name: str¶

Returns the name of the constraint.

property optimization_problem: OptimizationProblem¶

Returns the parent OptimizationProblem.

property rhs: float¶

Returns the right-hand-side of the constraint.

property sense: ConstraintSense¶

Returns the sense of the constraint.