qiskit-documentation/docs/api/qiskit/0.29/qiskit.chemistry.components...

43 lines
1.5 KiB
Plaintext
Raw Permalink Blame History

This file contains ambiguous Unicode characters

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: BosonicBasis (v0.29)
description: API reference for qiskit.chemistry.components.bosonic_bases.BosonicBasis in qiskit v0.29
in_page_toc_min_heading_level: 1
python_api_type: class
python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis
---
# BosonicBasis
<Class id="qiskit.chemistry.components.bosonic_bases.BosonicBasis" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/components/bosonic_bases/bosonic_basis.py" signature="BosonicBasis" modifiers="class">
Bases: `object`
Basis to express a second quantization Bosonic Hamiltonian.
## Methods
<span id="qiskit-chemistry-components-bosonic-bases-bosonicbasis-convert" />
### convert
<Function id="qiskit.chemistry.components.bosonic_bases.BosonicBasis.convert" signature="BosonicBasis.convert(threshold=1e-06)">
This prepares an array object representing a bosonic hamiltonian expressed in the harmonic basis. This object can directly be given to the BosonicOperator class to be mapped to a qubit hamiltonian.
**Parameters**
**threshold** (`float`) the matrix elements of value below this threshold are discarded
**Return type**
`List`\[`List`\[`Tuple`\[`List`\[`List`\[`int`]], `float`]]]
**Returns**
List of modes for input to creation of a bosonic hamiltonian in the harmonic basis
**Raises**
**ValueError** If problem with order value from computed modes
</Function>
</Class>