49 lines
2.1 KiB
Plaintext
49 lines
2.1 KiB
Plaintext
---
|
||
title: SciPyImaginaryEvolver
|
||
description: API reference for qiskit.algorithms.SciPyImaginaryEvolver
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.algorithms.SciPyImaginaryEvolver
|
||
---
|
||
|
||
# SciPyImaginaryEvolver
|
||
|
||
<Class id="qiskit.algorithms.SciPyImaginaryEvolver" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py" signature="qiskit.algorithms.SciPyImaginaryEvolver(num_timesteps)" modifiers="class">
|
||
Bases: [`ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver")
|
||
|
||
Classical Evolver for imaginary time evolution.
|
||
|
||
Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau = it$ under a Hamiltonian $H$, as provided in the `evolution_problem`. Note that the precision of the evolver does not depend on the number of timesteps taken.
|
||
|
||
**Parameters**
|
||
|
||
**num\_timesteps** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – The number of timesteps in the simulation.
|
||
|
||
**Raises**
|
||
|
||
[**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – If num\_timesteps is not a positive integer.
|
||
|
||
## Methods
|
||
|
||
### evolve
|
||
|
||
<Function id="qiskit.algorithms.SciPyImaginaryEvolver.evolve" signature="evolve(evolution_problem)">
|
||
Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$.
|
||
|
||
Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau$ under a Hamiltonian $H$, as provided in the `evolution_problem`.
|
||
|
||
**Parameters**
|
||
|
||
**evolution\_problem** ([*TimeEvolutionProblem*](qiskit.algorithms.TimeEvolutionProblem "qiskit.algorithms.time_evolvers.time_evolution_problem.TimeEvolutionProblem")) – The definition of the evolution problem.
|
||
|
||
**Returns**
|
||
|
||
Evolution result which includes an evolved quantum state.
|
||
|
||
**Return type**
|
||
|
||
[*TimeEvolutionResult*](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult")
|
||
</Function>
|
||
</Class>
|
||
|