37 lines
3.0 KiB
Plaintext
37 lines
3.0 KiB
Plaintext
---
|
|
title: initial_states (v0.29)
|
|
description: API reference for qiskit.aqua.components.initial_states in qiskit v0.29
|
|
in_page_toc_min_heading_level: 2
|
|
python_api_type: module
|
|
python_api_name: qiskit.aqua.components.initial_states
|
|
---
|
|
|
|
<span id="module-qiskit.aqua.components.initial_states" />
|
|
|
|
<span id="qiskit-aqua-components-initial-states" />
|
|
|
|
<span id="initial-states-qiskit-aqua-components-initial-states" />
|
|
|
|
# Initial States
|
|
|
|
`qiskit.aqua.components.initial_states`
|
|
|
|
Initial states are a fixed quantum state. These can be used, for example, to define a starting state for [`variational_forms`](qiskit.aqua.components.variational_forms#module-qiskit.aqua.components.variational_forms "qiskit.aqua.components.variational_forms"), such as when used with [`VQE`](qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE"), or to define a starting state for the evolution in algorithms such as [`QPE`](qiskit.aqua.algorithms.QPE "qiskit.aqua.algorithms.QPE") and [`IQPE`](qiskit.aqua.algorithms.IQPE "qiskit.aqua.algorithms.IQPE").
|
|
|
|
If you have a specific quantum circuit you would like to use as an initial state, and do not want to make a new class derived from [`InitialState`](qiskit.aqua.components.initial_states.InitialState "qiskit.aqua.components.initial_states.InitialState") to use it, this can be especially so if the circuit is fixed, then see [`Custom`](qiskit.aqua.components.initial_states.Custom "qiskit.aqua.components.initial_states.Custom") which allows it to be used as an [`InitialState`](qiskit.aqua.components.initial_states.InitialState "qiskit.aqua.components.initial_states.InitialState") for algorithms and components that expect this as a type.
|
|
|
|
# Initial State Base Class
|
|
|
|
| | |
|
|
| ------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
|
|
| [`InitialState`](qiskit.aqua.components.initial_states.InitialState "qiskit.aqua.components.initial_states.InitialState") | Base class for InitialState. |
|
|
|
|
# Initial States
|
|
|
|
| | |
|
|
| ------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- |
|
|
| [`Custom`](qiskit.aqua.components.initial_states.Custom "qiskit.aqua.components.initial_states.Custom") | The custom initial state. |
|
|
| [`VarFormBased`](qiskit.aqua.components.initial_states.VarFormBased "qiskit.aqua.components.initial_states.VarFormBased") | The variational form based initial state. |
|
|
| [`Zero`](qiskit.aqua.components.initial_states.Zero "qiskit.aqua.components.initial_states.Zero") | The zero (null/vacuum) state. |
|
|
|