qiskit-documentation/docs/api/qiskit/0.42/qiskit.algorithms.SciPyImag...

49 lines
2.0 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: 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.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py" signature="SciPyImaginaryEvolver(num_timesteps)" modifiers="class">
Bases: [`qiskit.algorithms.time_evolvers.imaginary_time_evolver.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`) The number of timesteps in the simulation.
**Raises**
**ValueError** If num\_timesteps is not a positive integer.
## Methods
### evolve
<Function id="qiskit.algorithms.SciPyImaginaryEvolver.evolve" signature="SciPyImaginaryEvolver.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.
**Return type**
[`TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult")
**Returns**
Evolution result which includes an evolved quantum state.
</Function>
</Class>