CplexOptimizer¶

class CplexOptimizer(disp=False)[source]¶

Bases: qiskit.optimization.algorithms.optimization_algorithm.OptimizationAlgorithm

The CPLEX optimizer wrapped as an Qiskit OptimizationAlgorithm.

This class provides a wrapper for cplex.Cplex (https://pypi.org/project/cplex/) to be used within the optimization module.

Examples

>>> from qiskit.optimization.problems import QuadraticProgram
>>> from qiskit.optimization.algorithms import CplexOptimizer
>>> problem = QuadraticProgram()
>>> # specify problem here, if cplex is installed
>>> optimizer = CplexOptimizer() if CplexOptimizer.is_cplex_installed() else None
>>> if optimizer: result = optimizer.solve(problem)

Initializes the CplexOptimizer.

Parameters: disp (bool) – Whether to print CPLEX output or not.
Raises: MissingOptionalLibraryError – CPLEX is not installed.

Methods

`get_compatibility_msg`	Checks whether a given problem can be solved with this optimizer.
`is_compatible`	Checks whether a given problem can be solved with the optimizer implementing this method.
`is_cplex_installed`	Returns True if cplex is installed
`solve`	Tries to solves the given problem using the optimizer.

Attributes

disp¶

Returns the display setting.

Return type: bool
Returns: Whether to print CPLEX information or not.