69 lines
2.9 KiB
Plaintext
69 lines
2.9 KiB
Plaintext
---
|
||
title: StateVectorCircuit
|
||
description: API reference for qiskit.aqua.circuits.StateVectorCircuit
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.aqua.circuits.StateVectorCircuit
|
||
---
|
||
|
||
# qiskit.aqua.circuits.StateVectorCircuit
|
||
|
||
<Class id="qiskit.aqua.circuits.StateVectorCircuit" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/circuits/statevector_circuit.py" signature="StateVectorCircuit(state_vector)" modifiers="class">
|
||
Arbitrary State-Vector Circuit.
|
||
|
||
Constructor.
|
||
|
||
**Parameters**
|
||
|
||
**state\_vector** (*numpy.ndarray*) – vector representation of the desired quantum state
|
||
|
||
**Raises**
|
||
|
||
[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.aqua.circuits.StateVectorCircuit.__init__" signature="__init__(state_vector)">
|
||
Constructor.
|
||
|
||
**Parameters**
|
||
|
||
**state\_vector** (*numpy.ndarray*) – vector representation of the desired quantum state
|
||
|
||
**Raises**
|
||
|
||
[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
|
||
| [`__init__`](#qiskit.aqua.circuits.StateVectorCircuit.__init__ "qiskit.aqua.circuits.StateVectorCircuit.__init__")(state\_vector) | Constructor. |
|
||
| [`construct_circuit`](#qiskit.aqua.circuits.StateVectorCircuit.construct_circuit "qiskit.aqua.circuits.StateVectorCircuit.construct_circuit")(\[circuit, register]) | Construct the circuit representing the desired state vector. |
|
||
|
||
### construct\_circuit
|
||
|
||
<Function id="qiskit.aqua.circuits.StateVectorCircuit.construct_circuit" signature="construct_circuit(circuit=None, register=None)">
|
||
Construct the circuit representing the desired state vector.
|
||
|
||
**Parameters**
|
||
|
||
* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The optional circuit to extend from.
|
||
* **register** (*Union(*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *, list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*])*) – The optional qubits to construct the circuit with.
|
||
|
||
**Returns**
|
||
|
||
quantum circuit
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
|
||
**Raises**
|
||
|
||
[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input
|
||
</Function>
|
||
</Class>
|
||
|