qiskit.optimization.algorithms.OptimizationAlgorithm

class OptimizationAlgorithm

An abstract class for optimization algorithms in Qiskit’s optimization module.

__init__()

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__()	Initialize self.
get_compatibility_msg(problem)	Checks whether a given problem can be solved with the optimizer implementing this method.
is_compatible(problem)	Checks whether a given problem can be solved with the optimizer implementing this method.
solve(problem)	Tries to solves the given problem using the optimizer.

abstract get_compatibility_msg(problem)

Checks whether a given problem can be solved with the optimizer implementing this method.

Parameter

problem (QuadraticProgram) – The optimization problem to check compatibility.

Rückgabetyp

str

Rückgabe

Returns the incompatibility message. If the message is empty no issues were found.

is_compatible(problem)

Checks whether a given problem can be solved with the optimizer implementing this method.

Parameter

problem (QuadraticProgram) – The optimization problem to check compatibility.

Rückgabetyp

bool

Rückgabe

Returns True if the problem is compatible, False otherwise.

abstract solve(problem)

Tries to solves the given problem using the optimizer.

Runs the optimizer to try to solve the optimization problem.

Parameter

problem (QuadraticProgram) – The problem to be solved.

Rückgabetyp

OptimizationResult

Rückgabe

The result of the optimizer applied to the problem.

Verursacht

QiskitOptimizationError – If the problem is incompatible with the optimizer.