IntegerVariable

class IntegerVariable

Bases: Variable

Represents an integer variable with specified bounds.

Methods

__init__	Initializes an integer variable with specified bounds and encoding method.
to_poly	Converts the variable to the Amplify SDK's polynomial representation.

Attributes

bounds	Returns the bounds of the variable.
encoding	Returns the encoding method for the variable.
name	Returns the name of the variable.
possible_values	Returns a list of possible values for a discrete variable, or a pair of boundary values for a continuous variable.
type	Returns the type of the variable.

__add__(other: Variable | Poly | float) → Poly

__eq__(other: object) → bool

Return self==value.

__hash__() → int

Return hash(self).

__init__(bounds: tuple[int, int], encoding: EncodingMethod = EncodingMethod.DomainWall) → None

Initializes an integer variable with specified bounds and encoding method.

Parameters:

• bounds (tuple[int, int]) – The lower and upper bounds for the variable.

• encoding (EncodingMethod, optional) – The encoding method to use. Defaults to EncodingMethod.DomainWall.

Raises:

• ValueError – If the bounds are invalid.

• TypeError – If the bounds are not integers.

• TypeError – If the encoding method is invalid.

__mul__(other: Variable | Poly | float) → Poly

__ne__(other: object) → bool

Return self!=value.

__neg__() → Poly

__pos__() → Poly

__pow__(other: int) → Poly

__radd__(other: Poly | float) → Poly

__repr__() → str

Return repr(self).

__rmul__(other: Poly | float) → Poly

__rsub__(other: Poly | float) → Poly

__str__() → str

Return str(self).

__sub__(other: Variable | Poly | float) → Poly

__truediv__(other: float) → Poly

to_poly() → Poly

Converts the variable to the Amplify SDK’s polynomial representation.

Returns:

The Amplify SDK’s polynomial representation of the variable.

Return type:

amplify.Poly

__dict__ = mappingproxy({'__module__': 'amplify_bbopt.variable', '__doc__': 'Represents an integer variable with specified bounds.', '__init__': <function IntegerVariable.__init__>, '__annotations__': {}})

__weakref__

list of weak references to the object (if defined)

property bounds: tuple[float | None, float | None] | None

Returns the bounds of the variable.

property encoding: _EncodingMethodBase

Returns the encoding method for the variable.

property name: str

Returns the name of the variable.

property possible_values: list[float | int] | tuple[float, float]

Returns a list of possible values for a discrete variable, or a pair of boundary values for a continuous variable.

Returns:

The possible values or bounds.

Return type:

list[float | int] | tuple[float, float]

property type: VariableType

Returns the type of the variable.