113 lines
5.7 KiB
Plaintext
113 lines
5.7 KiB
Plaintext
---
|
||
title: TimeEvolutionProblem
|
||
description: API reference for qiskit.algorithms.TimeEvolutionProblem
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.algorithms.TimeEvolutionProblem
|
||
---
|
||
|
||
# TimeEvolutionProblem
|
||
|
||
<Class id="qiskit.algorithms.TimeEvolutionProblem" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.25/qiskit/algorithms/time_evolvers/time_evolution_problem.py" signature="qiskit.algorithms.TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)" modifiers="class">
|
||
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.12)")
|
||
|
||
Time evolution problem class.
|
||
|
||
This class is the input to time evolution algorithms and must contain information on the total evolution time, a quantum state to be evolved and under which Hamiltonian the state is evolved.
|
||
|
||
### hamiltonian
|
||
|
||
<Attribute id="qiskit.algorithms.TimeEvolutionProblem.hamiltonian">
|
||
The Hamiltonian under which to evolve the system.
|
||
|
||
**Type**
|
||
|
||
BaseOperator | [PauliSumOp](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.PauliSumOp")
|
||
</Attribute>
|
||
|
||
### initial\_state
|
||
|
||
<Attribute id="qiskit.algorithms.TimeEvolutionProblem.initial_state">
|
||
The quantum state to be evolved for methods like Trotterization. For variational time evolutions, where the evolution happens in an ansatz, this argument is not required.
|
||
|
||
**Type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") | [Statevector](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") | None
|
||
</Attribute>
|
||
|
||
### aux\_operators
|
||
|
||
<Attribute id="qiskit.algorithms.TimeEvolutionProblem.aux_operators">
|
||
Optional list of auxiliary operators to be evaluated with the evolved `initial_state` and their expectation values returned.
|
||
|
||
**Type**
|
||
|
||
ListOrDict\[BaseOperator | [PauliSumOp](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.PauliSumOp")] | None
|
||
</Attribute>
|
||
|
||
### truncation\_threshold
|
||
|
||
<Attribute id="qiskit.algorithms.TimeEvolutionProblem.truncation_threshold">
|
||
Defines a threshold under which values can be assumed to be 0. Used when `aux_operators` is provided.
|
||
|
||
**Type**
|
||
|
||
[float](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")
|
||
</Attribute>
|
||
|
||
### t\_param
|
||
|
||
<Attribute id="qiskit.algorithms.TimeEvolutionProblem.t_param">
|
||
Time parameter in case of a time-dependent Hamiltonian. This free parameter must be within the `hamiltonian`.
|
||
|
||
**Type**
|
||
|
||
[Parameter](qiskit.circuit.Parameter "qiskit.circuit.Parameter") | None
|
||
</Attribute>
|
||
|
||
### param\_value\_map
|
||
|
||
<Attribute id="qiskit.algorithms.TimeEvolutionProblem.param_value_map">
|
||
Maps free parameters in the problem to values. Depending on the algorithm, it might refer to e.g. a Hamiltonian or an initial state.
|
||
|
||
**Type**
|
||
|
||
[dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)")\[[Parameter](qiskit.circuit.Parameter "qiskit.circuit.Parameter"), [complex](https://docs.python.org/3/library/functions.html#complex "(in Python v3.12)")] | None
|
||
</Attribute>
|
||
|
||
**Parameters**
|
||
|
||
* **hamiltonian** (*BaseOperator |* [*PauliSumOp*](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.PauliSumOp")) – The Hamiltonian under which to evolve the system.
|
||
* **time** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – Total time of evolution.
|
||
* **initial\_state** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *|*[*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *| None*) – The quantum state to be evolved for methods like Trotterization. For variational time evolutions, where the evolution happens in an ansatz, this argument is not required.
|
||
* **aux\_operators** (*ListOrDict\[BaseOperator |* [*PauliSumOp*](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.PauliSumOp")*] | None*) – Optional list of auxiliary operators to be evaluated with the evolved `initial_state` and their expectation values returned.
|
||
* **truncation\_threshold** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – Defines a threshold under which values can be assumed to be 0. Used when `aux_operators` is provided.
|
||
* **t\_param** ([*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter") *| None*) – Time parameter in case of a time-dependent Hamiltonian. This free parameter must be within the `hamiltonian`.
|
||
* **param\_value\_map** (*Mapping\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*,* [*complex*](https://docs.python.org/3/library/functions.html#complex "(in Python v3.12)")*] | None*) – Maps free parameters in the problem to values. Depending on the algorithm, it might refer to e.g. a Hamiltonian or an initial state.
|
||
|
||
**Raises**
|
||
|
||
[**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – If non-positive time of evolution is provided.
|
||
|
||
## Attributes
|
||
|
||
### time
|
||
|
||
<Attribute id="qiskit.algorithms.TimeEvolutionProblem.time">
|
||
Returns time.
|
||
</Attribute>
|
||
|
||
## Methods
|
||
|
||
### validate\_params
|
||
|
||
<Function id="qiskit.algorithms.TimeEvolutionProblem.validate_params" signature="validate_params()">
|
||
Checks if all parameters present in the Hamiltonian are also present in the dictionary that maps them to values.
|
||
|
||
**Raises**
|
||
|
||
[**ValueError**](https://docs.python.org/3/library/exceptions.html#ValueError "(in Python v3.12)") – If Hamiltonian parameters cannot be bound with data provided.
|
||
</Function>
|
||
</Class>
|
||
|