qiskit_addon_opt_mapper.applications.GraphOptimizationApplication

class GraphOptimizationApplication(graph)[source]

Bases: OptimizationApplication

An abstract class for graph optimization applications.

Init method.

Parameters:
  • graph (Graph | ndarray | list | PyGraph) –

    A graph representing a problem. It can be specified in the following formats:

    • A Rustworkx undirected graph (rx.PyGraph)

    • A NetworkX undirected graph (nx.Graph)

    • A NumPy adjacency matrix (np.ndarray)

    • A list of edges or adjacency list (list)

  • rx.PyGraph. (The input graph will be internally normalized to a)

__init__(graph)[source]

Init method.

Parameters:
  • graph (Graph | ndarray | list | PyGraph) –

    A graph representing a problem. It can be specified in the following formats:

    • A Rustworkx undirected graph (rx.PyGraph)

    • A NetworkX undirected graph (nx.Graph)

    • A NumPy adjacency matrix (np.ndarray)

    • A list of edges or adjacency list (list)

  • rx.PyGraph. (The input graph will be internally normalized to a)

Return type:

None

Methods

__init__(graph)

Init method.

draw([result, pos])

Draw a graph with the result.

interpret(result)

Interpret the problem.

sample_most_likely(state_vector)

Compute the most likely binary string from state vector.

to_optimization_problem()

Represent as an optimization problem.

Attributes

graph

Getter of the graph.

nx_graph

Getter of the graph in Networkx format.

draw(result=None, pos=None)[source]

Draw a graph with the result.

When the result is None, draw an original graph without colors.

Parameters:
  • result (ndarray | None) – The calculated result for the problem

  • pos (dict[int, ndarray] | None) – The positions of nodes

Return type:

None

property graph: PyGraph

Getter of the graph.

Returns:

A graph for a problem

abstract interpret(result)[source]

Interpret the problem.

Convert the calculation result of the problem (SolverResult or a binary array using np.ndarray) to the answer of the problem in an easy-to-understand format.

Parameters:

result (ndarray) – The calculated result of the problem

property nx_graph: Graph

Getter of the graph in Networkx format.

Returns:

A graph for a problem

static sample_most_likely(state_vector)[source]

Compute the most likely binary string from state vector.

Parameters:

state_vector (QuasiDistribution | Statevector | ndarray | dict) – state vector or counts or quasi-probabilities.

Returns:

binary string as numpy.ndarray of ints.

Raises:

ValueError – if state_vector is not QuasiDistribution, Statevector, np.ndarray, or dict.

Return type:

ndarray

abstract to_optimization_problem()[source]

Represent as an optimization problem.

Convert a problem instance into a OptimizationProblem

Return type:

OptimizationProblem