Values¶

class Values¶

Mapping from variables to numeric values in a solution.

Methods

`__init__`
`items`
`keys`
`values`

class ItemsView¶

View of key-value pairs in Values.

__bool__(self) → bool¶

Return type:: bool

__init__(*args, **kwargs)¶

__iter__(self) → ItemsView¶

Return type:: ItemsView

__len__(self) → int¶

Return type:: int

__next__(self) → tuple[Poly, float]¶

Return type:: tuple[Poly, float]

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

class KeysView¶

View of keys in Values.

__bool__(self) → bool¶

Return type:: bool

__contains__(self, arg: Poly, /) → bool¶

__contains__(self, arg: object, /) → bool

__contains__

Overload 1.

Args:

arg (amplify.Poly)

Returns:

bool:

Overload 2.

Args:

arg (object)

Returns:

bool:

__init__(*args, **kwargs)¶

__iter__(self) → KeysView¶

Return type:: KeysView

__len__(self) → int¶

Return type:: int

__next__(self) → Poly¶

Return type:: Poly

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

class ValuesView¶

View of values in Values.

__bool__(self) → bool¶

Return type:: bool

__init__(*args, **kwargs)¶

__iter__(self) → ValuesView¶

Return type:: ValuesView

__len__(self) → int¶

Return type:: int

__next__(self) → float¶

Return type:: float

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

__bool__(self) → bool¶

Return type:: bool

__contains__(self, arg: Poly, /) → bool¶

__contains__(self, arg: object, /) → bool

__contains__

Overload 1.

Args:

arg (amplify.Poly)

Returns:

bool:

Overload 2.

Args:

arg (object)

Returns:

bool:

__getitem__(self, arg: Poly, /) → float¶

Return the value of the variable.

Parameters:: arg (Poly) – The variable to look up. It has to be a polynomial of one variable.
Returns:: The value that the solution gives to the variable.
Return type:: float
Raises:: KeyError – The key is not a single variable, it comes from another VariableGenerator, or the solution gives it no value.

__init__(*args, **kwargs)¶

__iter__(self) → KeysView¶

Return type:: KeysView

__len__(self) → int¶

Return type:: int

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

items(self) → ItemsView¶

Return type:: ItemsView

keys(self) → KeysView¶

Return type:: KeysView

values(self) → ValuesView¶

Return type:: ValuesView