78 lines
2.5 KiB
Plaintext
78 lines
2.5 KiB
Plaintext
---
|
||
title: IntegerToBinary
|
||
description: API reference for qiskit.optimization.converters.IntegerToBinary
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.optimization.converters.IntegerToBinary
|
||
---
|
||
|
||
# IntegerToBinary
|
||
|
||
<Class id="qiskit.optimization.converters.IntegerToBinary" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/optimization/converters/integer_to_binary.py" signature="IntegerToBinary" modifiers="class">
|
||
Bases: `qiskit.optimization.converters.quadratic_program_converter.QuadraticProgramConverter`
|
||
|
||
Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables.
|
||
|
||
This bounded-coefficient encoding used in this converted is proposed in \[1], Eq. (5).
|
||
|
||
**Examples**
|
||
|
||
```python
|
||
>>> from qiskit.optimization.problems import QuadraticProgram
|
||
>>> from qiskit.optimization.converters import IntegerToBinary
|
||
>>> problem = QuadraticProgram()
|
||
>>> var = problem.integer_var(name='x', lowerbound=0, upperbound=10)
|
||
>>> conv = IntegerToBinary()
|
||
>>> problem2 = conv.convert(problem)
|
||
```
|
||
|
||
**References**
|
||
|
||
**\[1]: Sahar Karimi, Pooya Ronagh (2017), Practical Integer-to-Binary Mapping for Quantum**
|
||
|
||
Annealers. arxiv.org:1706.01945.
|
||
|
||
## Methods
|
||
|
||
### convert
|
||
|
||
<Function id="qiskit.optimization.converters.IntegerToBinary.convert" signature="IntegerToBinary.convert(problem)">
|
||
Convert an integer problem into a new problem with binary variables.
|
||
|
||
**Parameters**
|
||
|
||
**problem** (`QuadraticProgram`) – The problem to be solved, that may contain integer variables.
|
||
|
||
**Return type**
|
||
|
||
`QuadraticProgram`
|
||
|
||
**Returns**
|
||
|
||
The converted problem, that contains no integer variables.
|
||
|
||
**Raises**
|
||
|
||
[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if variable or constraint type is not supported.
|
||
</Function>
|
||
|
||
### interpret
|
||
|
||
<Function id="qiskit.optimization.converters.IntegerToBinary.interpret" signature="IntegerToBinary.interpret(x)">
|
||
Convert back the converted problem (binary variables) to the original (integer variables).
|
||
|
||
**Parameters**
|
||
|
||
**x** (`Union`\[`ndarray`, `List`\[`float`]]) – The result of the converted problem or the given result in case of FAILURE.
|
||
|
||
**Return type**
|
||
|
||
`ndarray`
|
||
|
||
**Returns**
|
||
|
||
The result of the original problem.
|
||
</Function>
|
||
</Class>
|
||
|