qiskit-documentation/docs/api/qiskit/0.24/qiskit.optimization.applica...

65 lines
2.8 KiB
Plaintext
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: partition
description: API reference for qiskit.optimization.applications.ising.partition
in_page_toc_min_heading_level: 2
python_api_type: module
python_api_name: qiskit.optimization.applications.ising.partition
---
<span id="module-qiskit.optimization.applications.ising.partition" />
<span id="qiskit-optimization-applications-ising-partition" />
# qiskit.optimization.applications.ising.partition
Generate Number Partitioning (Partition) instances, and convert them into a Hamiltonian given as a Pauli list.
**Functions**
| | |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| [`get_operator`](#qiskit.optimization.applications.ising.partition.get_operator "qiskit.optimization.applications.ising.partition.get_operator")(values) | Construct the Hamiltonian for a given Partition instance. |
| [`partition_value`](#qiskit.optimization.applications.ising.partition.partition_value "qiskit.optimization.applications.ising.partition.partition_value")(x, number\_list) | Compute the value of a partition. |
### get\_operator
<Function id="qiskit.optimization.applications.ising.partition.get_operator" github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/partition.py" signature="get_operator(values)">
Construct the Hamiltonian for a given Partition instance.
Given a list of numbers for the Number Partitioning problem, we construct the Hamiltonian described as a list of Pauli gates.
**Parameters**
**values** (*numpy.ndarray*) array of values.
**Returns**
operator for the Hamiltonian and a constant shift for the obj function.
**Return type**
tuple([WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator"), float)
</Function>
### partition\_value
<Function id="qiskit.optimization.applications.ising.partition.partition_value" github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.8/qiskit/optimization/applications/ising/partition.py" signature="partition_value(x, number_list)">
Compute the value of a partition.
**Parameters**
* **x** (*numpy.ndarray*) binary string as numpy array.
* **number\_list** (*numpy.ndarray*) list of numbers in the instance.
**Returns**
**difference squared between the two sides of the number**
partition.
**Return type**
float
</Function>