56 lines
2.5 KiB
Plaintext
56 lines
2.5 KiB
Plaintext
---
|
||
title: BOPESSampler (v0.29)
|
||
description: API reference for qiskit.chemistry.algorithms.pes_samplers.BOPESSampler in qiskit v0.29
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler
|
||
---
|
||
|
||
# BOPESSampler
|
||
|
||
<Class id="qiskit.chemistry.algorithms.pes_samplers.BOPESSampler" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/algorithms/pes_samplers/bopes_sampler.py" signature="BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)" modifiers="class">
|
||
Bases: `object`
|
||
|
||
Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES).
|
||
|
||
**Parameters**
|
||
|
||
* **gss** (`GroundStateSolver`) – GroundStateSolver
|
||
* **tolerance** (`float`) – Tolerance desired for minimum energy.
|
||
* **bootstrap** (`bool`) – Whether to warm-start the solution of variational minimum eigensolvers.
|
||
* **num\_bootstrap** (`Optional`\[`int`]) – Number of previous points for extrapolation and bootstrapping. If None and a list of extrapolators is defined, the first two points will be used for bootstrapping. If no extrapolator is defined and bootstrap is True, all previous points will be used for bootstrapping.
|
||
* **extrapolator** (`Optional`\[`Extrapolator`]) – Extrapolator objects that define space/window and method to extrapolate variational parameters.
|
||
|
||
**Raises**
|
||
|
||
[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If `num_boostrap` is an integer smaller than 2, or if `num_boostrap` is larger than 2 and the extrapolator is not an instance of `WindowExtrapolator`.
|
||
|
||
## Methods
|
||
|
||
<span id="qiskit-chemistry-algorithms-pes-samplers-bopessampler-sample" />
|
||
|
||
### sample
|
||
|
||
<Function id="qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.sample" signature="BOPESSampler.sample(driver, points)">
|
||
Run the sampler at the given points, potentially with repetitions.
|
||
|
||
**Parameters**
|
||
|
||
* **driver** (`BaseDriver`) – BaseDriver specific for the problem. The driver should be based on a Molecule object that has perturbations to be varied.
|
||
* **points** (`List`\[`float`]) – The points along the degrees of freedom to evaluate.
|
||
|
||
**Return type**
|
||
|
||
`BOPESSamplerResult`
|
||
|
||
**Returns**
|
||
|
||
BOPES Sampler Result
|
||
|
||
**Raises**
|
||
|
||
[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if the driver does not have a molecule specified.
|
||
</Function>
|
||
</Class>
|
||
|