Variable

class Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=VarType.CONTINUOUS)[source]

Bases: QuadraticProgramElement

Representation of a variable.

Creates a new Variable.

The variables is exposed by the top-level QuadraticProgram class in QuadraticProgram.variables. This constructor is not meant to be used externally.

Parameters:

  • quadratic_program (Any) – The parent QuadraticProgram.

  • name (str) – The variable name.

  • lowerbound (float | int) – The variable lowerbound.

  • upperbound (float | int) – The variable upperbound.

  • vartype (VarType) – The variable type.

Raises:

QiskitOptimizationError – if lowerbound is greater than upperbound.

Attributes

lowerbound

Returns the lowerbound of the variable.

Returns:

The lower bound of the variable.

name

Returns the name of the variable.

Returns:

The name of the variable.

quadratic_program

Returns the parent QuadraticProgram.

Returns:

The parent QuadraticProgram.

upperbound

Returns the upperbound of the variable.

Returns:

The upperbound of the variable.

vartype

Returns the type of the variable.

Returns:

The variable type.

Methods

as_tuple()[source]

Returns a tuple corresponding to this variable.

Returns:

A tuple corresponding to this variable consisting of name, lowerbound, upperbound and variable type.

Return type:

tuple[str, float | int, float | int, VarType]