73 lines
2.4 KiB
Plaintext
73 lines
2.4 KiB
Plaintext
---
|
||
title: FeatureMap
|
||
description: API reference for qiskit.aqua.components.feature_maps.FeatureMap
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.aqua.components.feature_maps.FeatureMap
|
||
---
|
||
|
||
# FeatureMap
|
||
|
||
<Class id="qiskit.aqua.components.feature_maps.FeatureMap" isDedicatedPage={true} github="https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/feature_maps/feature_map.py" signature="FeatureMap" modifiers="class">
|
||
Bases: `abc.ABC`
|
||
|
||
Base class for FeatureMap.
|
||
|
||
This method should initialize the module and use an exception if a component of the module is not available.
|
||
|
||
## Methods
|
||
|
||
### construct\_circuit
|
||
|
||
<Function id="qiskit.aqua.components.feature_maps.FeatureMap.construct_circuit" signature="FeatureMap.construct_circuit(x, qr=None, inverse=False)" modifiers="abstract">
|
||
Construct the variational form, given its parameters.
|
||
|
||
**Parameters**
|
||
|
||
* **x** (*numpy.ndarray\[float]*) – 1-D array, data
|
||
* **qr** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – the QuantumRegister object for the circuit, if None, generate new registers with name q.
|
||
* **inverse** (*bool*) – whether or not inverse the circuit
|
||
|
||
**Returns**
|
||
|
||
a quantum circuit.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### get\_entangler\_map
|
||
|
||
<Function id="qiskit.aqua.components.feature_maps.FeatureMap.get_entangler_map" signature="FeatureMap.get_entangler_map(map_type, num_qubits)" modifiers="static">
|
||
get entangle map
|
||
</Function>
|
||
|
||
### validate\_entangler\_map
|
||
|
||
<Function id="qiskit.aqua.components.feature_maps.FeatureMap.validate_entangler_map" signature="FeatureMap.validate_entangler_map(entangler_map, num_qubits)" modifiers="static">
|
||
validate entangler map
|
||
</Function>
|
||
|
||
## Attributes
|
||
|
||
### feature\_dimension
|
||
|
||
<Attribute id="qiskit.aqua.components.feature_maps.FeatureMap.feature_dimension">
|
||
returns feature dimension
|
||
</Attribute>
|
||
|
||
### num\_qubits
|
||
|
||
<Attribute id="qiskit.aqua.components.feature_maps.FeatureMap.num_qubits">
|
||
returns number of qubits
|
||
</Attribute>
|
||
|
||
### support\_parameterized\_circuit
|
||
|
||
<Attribute id="qiskit.aqua.components.feature_maps.FeatureMap.support_parameterized_circuit">
|
||
returns whether or not the sub-class support parameterized circuit
|
||
</Attribute>
|
||
</Class>
|
||
|