Result¶

class Result¶

Container of optimization solutions and conversion/runtime metadata.

Methods

`__init__`
`sort`	Sort solutions by feasibility and objective value.

Attributes

`best`	Best solution in the result set.
`client_result`	Solver/client result.
`embedding`	Graph embedding information.
`execution_time`	The time the solver used to solve the problem.
`filter_solution`	Whether to filter out infeasible solutions.
`intermediate`	Model conversion information.
`num_solves`	Number of solve executions aggregated.
`response_time`	The time between sending the request and receiving the response from the solver.
`solutions`	View of all solutions.
`split`	Split view for each independent solve.
`total_time`	Total time including conversion and solve.

class GraphConversion¶

Graph embedding conversion details used during solving.

class ChainBreakFractions¶

List-like view of chain break fractions.

class Iterator¶

__init__(*args, **kwargs)¶

__iter__(self) → Iterator¶

Return type:: Iterator

__next__(self) → float¶

Return type:: float

__bool__(self) → bool¶

Return type:: bool

__getitem__(self, key: int) → float¶

Return the element at the index.

A negative index counts from the end, as in a Python list.

Parameters:: key (int) – The index of the element.
Return type:: float
Raises:: IndexError – The index is out of range.

__init__(*args, **kwargs)¶

__iter__(self) → Iterator¶

Return type:: Iterator

__len__(self) → int¶

Return type:: int

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

__init__(*args, **kwargs)¶

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

property chain_break_fractions¶

Chain break fraction for each solve.

Return type:: ChainBreakFractions

property chains¶

Embedding chains for each logical variable.

Return type:: list[ndarray[dtype=uint32, writable=False]]

property dst_graph¶

Destination (physical) graph used for embedding.

Return type:: Graph

property num_variables¶

Number of physical variables used after embedding.

Return type:: int

property poly¶

Embedded polynomial.

Return type:: Poly

property src_graph¶

Source (input polynomial) graph for embedding.

Return type:: list[tuple[int, int]]

property values_list¶

Physical variable assignments for each solve.

Return type:: ValuesList

class ModelConversion¶

Model conversion details used during solving.

class IntermediateMapping¶

Mapping between original and intermediate variables during model conversion.

class ItemsView¶

View of key-value pairs in IntermediateMapping.

__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, Poly]¶

Return type:: tuple[Poly, Poly]

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

class KeysView¶

View of keys in IntermediateMapping.

__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 IntermediateMapping.

__bool__(self) → bool¶

Return type:: bool

__init__(*args, **kwargs)¶

__iter__(self) → ValuesView¶

Return type:: ValuesView

__len__(self) → int¶

Return type:: int

__next__(self) → Poly¶

Return type:: Poly

__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, /) → Poly¶

Return the intermediate expression of the input variable.

Parameters:: arg (Poly) – The input variable to look up. It has to be a polynomial of one variable.
Returns:: The expression in the intermediate variables that replaced the input variable.
Return type:: Poly
Raises:: KeyError – The mapping holds no entry for the variable.

__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

__init__(*args, **kwargs)¶

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

property mapping¶

Mapping from input variables to intermediate expressions.

Return type:: IntermediateMapping

property model¶

Intermediate model.

Return type:: Model

property num_variables¶

Number of variables in the intermediate model.

Return type:: int

property values_list¶

Intermediate variable assignments for each solve.

Return type:: ValuesList

class Solution¶

Single solution entry in Result.

__init__(*args, **kwargs)¶

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

property feasible¶

Whether all constraints are satisfied.

Return type:: bool

property objective¶

Objective function value.

Return type:: float

property time¶

Time at which the solver found this solution.

Return type:: timedelta

property values¶

Variable assignments of the solution.

Return type:: Values

class SolutionList¶

List-like view of solutions.

class Iterator¶

__init__(*args, **kwargs)¶

__iter__(self) → Iterator¶

Return type:: Iterator

__next__(self) → Solution¶

Return type:: Solution

__bool__(self) → bool¶

Return type:: bool

__getitem__(self, key: int) → Solution¶

Return the element at the index.

A negative index counts from the end, as in a Python list.

Parameters:: key (int) – The index of the element.
Return type:: Solution
Raises:: IndexError – The index is out of range.

__init__(*args, **kwargs)¶

__iter__(self) → Iterator¶

Return type:: Iterator

__len__(self) → int¶

Return type:: int

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

class SplitView¶

List-of-list-like view of solutions that splits solutions by independent solves.

__bool__(self) → bool¶

Return type:: bool

__getitem__(self, key: int) → Result¶

Return the element at the index.

A negative index counts from the end, as in a Python list.

Parameters:: key (int) – The index of the element.
Return type:: Result
Raises:: IndexError – The index is out of range.

__init__(*args, **kwargs)¶

__iter__(self) → SplitView¶

Return type:: SplitView

__len__(self) → int¶

Return type:: int

__next__(self) → Result¶

Return type:: Result

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

class ValuesList¶

List-like view of value mappings for solutions.

class Iterator¶

__init__(*args, **kwargs)¶

__iter__(self) → Iterator¶

Return type:: Iterator

__next__(self) → Values¶

Return type:: Values

__bool__(self) → bool¶

Return type:: bool

__getitem__(self, key: int) → Values¶

Return the element at the index.

A negative index counts from the end, as in a Python list.

Parameters:: key (int) – The index of the element.
Return type:: Values
Raises:: IndexError – The index is out of range.

__init__(*args, **kwargs)¶

__iter__(self) → Iterator¶

Return type:: Iterator

__len__(self) → int¶

Return type:: int

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

__getitem__(self, key: int) → Solution¶

Return the element at the index.

A negative index counts from the end, as in a Python list.

Parameters:: key (int) – The index of the element.
Return type:: Solution
Raises:: IndexError – The index is out of range.

__init__(*args, **kwargs)¶

__iter__(self) → Iterator¶

Return type:: Iterator

__len__(self) → int¶

Return type:: int

__repr__(self) → str¶

Return type:: str

__str__(self) → str¶

Return type:: str

sort(self) → None¶: Sort solutions by feasibility and objective value.

__nb_signature__ = 'class Result(typing.Generic[_BaseClient_co])'¶

property best¶

Best solution in the result set.

The best solution is the feasible solution with the smallest objective value. When filter_solution is True, the result holds only the feasible solutions, so this property raises as soon as the result is empty.

Returns:: The solution that has the smallest objective value among the feasible solutions.
Return type:: Solution
Raises:: RuntimeError – The result holds no solution, or it holds no feasible solution.

property client_result¶

Solver/client result.

The raw response of the machine. Its type depends on the client that solved the model. It is None when the solve kept no client result, as after a conversion only run.

Return type:: Result | Result | SampleSet | SampleSet | SampleSet | Result | Result | Result | Result | object | None

property embedding¶

Graph embedding information.

Return type:: GraphConversion | None

property execution_time¶

The time the solver used to solve the problem.

Return type:: timedelta

property filter_solution¶

Whether to filter out infeasible solutions.

Return type:: bool

property intermediate¶

Model conversion information.

Return type:: ModelConversion

property num_solves¶

Number of solve executions aggregated.

Return type:: int

property response_time¶

The time between sending the request and receiving the response from the solver.

Return type:: timedelta

property solutions¶

View of all solutions.

Return type:: SolutionList

property split¶

Split view for each independent solve.

Return type:: SplitView

property total_time¶

Total time including conversion and solve.

Return type:: timedelta