Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/apidocs/qiskit_optimization.translators.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.. _qiskit_optimization-translators:

.. automodule:: qiskit_optimization.translators
:no-members:
:no-inherited-members:
1 change: 1 addition & 0 deletions qiskit_optimization/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@
applications
converters
problems
translators

"""

Expand Down
5 changes: 5 additions & 0 deletions qiskit_optimization/problems/quadratic_program.py
Original file line number Diff line number Diff line change
Expand Up @@ -874,6 +874,7 @@ def from_docplex(self, model: Model) -> None:
Raises:
QiskitOptimizationError: if the model contains unsupported elements.
"""
# pylint: disable=cyclic-import
from ..translators.docplex_mp import from_docplex_mp

other = from_docplex_mp(model)
Expand All @@ -892,6 +893,7 @@ def to_docplex(self) -> Model:
Raises:
QiskitOptimizationError: if non-supported elements (should never happen).
"""
# pylint: disable=cyclic-import
from ..translators.docplex_mp import to_docplex_mp

return to_docplex_mp(self)
Expand All @@ -902,6 +904,7 @@ def export_as_lp_string(self) -> str:
Returns:
A string representing the quadratic program.
"""
# pylint: disable=cyclic-import
from ..translators.docplex_mp import to_docplex_mp

return to_docplex_mp(self).export_as_lp_string()
Expand Down Expand Up @@ -942,6 +945,7 @@ def _parse_problem_name(filename: str) -> str:
break
return model_name

# pylint: disable=cyclic-import
from ..translators.docplex_mp import from_docplex_mp

model = ModelReader().read(filename, model_name=_parse_problem_name(filename))
Expand All @@ -961,6 +965,7 @@ def write_to_lp_file(self, filename: str) -> None:
OSError: If this cannot open a file.
DOcplexException: If filename is an empty string
"""
# pylint: disable=cyclic-import
from ..translators.docplex_mp import to_docplex_mp

mdl = to_docplex_mp(self)
Expand Down
13 changes: 4 additions & 9 deletions qiskit_optimization/translators/docplex_mp.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

"""Translator between a docplex.mp model and a quadratic program"""

from typing import TYPE_CHECKING, cast
from typing import cast

from docplex.mp.constr import LinearConstraint as DocplexLinearConstraint
from docplex.mp.constr import NotEqualConstraint
Expand All @@ -27,12 +27,10 @@
from qiskit_optimization.problems.quadratic_objective import QuadraticObjective
from qiskit_optimization.problems.variable import Variable

if TYPE_CHECKING:
# pylint: disable=cyclic-import
from qiskit_optimization.problems.quadratic_program import QuadraticProgram
from qiskit_optimization.problems.quadratic_program import QuadraticProgram


def to_docplex_mp(quadratic_program: "QuadraticProgram") -> Model:
def to_docplex_mp(quadratic_program: QuadraticProgram) -> Model:
"""Returns a docplex.mp model corresponding to a quadratic program.

Args:
Expand Down Expand Up @@ -126,7 +124,7 @@ def to_docplex_mp(quadratic_program: "QuadraticProgram") -> Model:
return mdl


def from_docplex_mp(model: Model) -> "QuadraticProgram":
def from_docplex_mp(model: Model) -> QuadraticProgram:
"""Translate a docplex.mp model into a quadratic program.

Note that this supports only basic functions of docplex as follows:
Expand All @@ -146,9 +144,6 @@ def from_docplex_mp(model: Model) -> "QuadraticProgram":
if not isinstance(model, Model):
raise QiskitOptimizationError(f"The model is not compatible: {model}")

# pylint: disable=cyclic-import
from qiskit_optimization.problems.quadratic_program import QuadraticProgram

quadratic_program = QuadraticProgram()

# get name
Expand Down
13 changes: 4 additions & 9 deletions qiskit_optimization/translators/gurobipy.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

"""Translator between a gurobipy model and a quadratic program"""

from typing import TYPE_CHECKING, cast
from typing import cast

try:
import gurobipy as gp
Expand All @@ -36,9 +36,7 @@ class Model: # type: ignore
from qiskit_optimization.problems.quadratic_objective import QuadraticObjective
from qiskit_optimization.problems.variable import Variable

if TYPE_CHECKING:
# pylint: disable=cyclic-import
from qiskit_optimization.problems.quadratic_program import QuadraticProgram
from qiskit_optimization.problems.quadratic_program import QuadraticProgram


def _check_gurobipy_is_installed(name: str):
Expand All @@ -50,7 +48,7 @@ def _check_gurobipy_is_installed(name: str):
)


def to_gurobipy(quadratic_program: "QuadraticProgram") -> Model:
def to_gurobipy(quadratic_program: QuadraticProgram) -> Model:
"""Returns a gurobipy model corresponding to a quadratic program.

Args:
Expand Down Expand Up @@ -146,7 +144,7 @@ def to_gurobipy(quadratic_program: "QuadraticProgram") -> Model:
return mdl


def from_gurobipy(model: Model) -> "QuadraticProgram":
def from_gurobipy(model: Model) -> QuadraticProgram:
"""Translate a gurobipy model into a quadratic program.

Note that this supports only basic functions of gurobipy as follows:
Expand All @@ -170,9 +168,6 @@ def from_gurobipy(model: Model) -> "QuadraticProgram":
if not isinstance(model, Model):
raise QiskitOptimizationError(f"The model is not compatible: {model}")

# pylint: disable=cyclic-import
from qiskit_optimization.problems.quadratic_program import QuadraticProgram

quadratic_program = QuadraticProgram()

# Update the model to make sure everything works as expected
Expand Down