diff --git a/docs/api/qiskit/0.41/_toc.json b/docs/api/qiskit/0.41/_toc.json index 890f12cfe64..1a799fe87c3 100644 --- a/docs/api/qiskit/0.41/_toc.json +++ b/docs/api/qiskit/0.41/_toc.json @@ -2930,10 +2930,6 @@ "title": "Constant", "url": "/api/qiskit/0.41/qiskit.pulse.library.Constant" }, - { - "title": "constant", - "url": "/api/qiskit/0.41/qiskit.pulse.library.constant" - }, { "title": "control_channels", "url": "/api/qiskit/0.41/qiskit.pulse.builder.control_channels" @@ -2966,10 +2962,6 @@ "title": "Drag", "url": "/api/qiskit/0.41/qiskit.pulse.library.Drag" }, - { - "title": "drag", - "url": "/api/qiskit/0.41/qiskit.pulse.library.drag" - }, { "title": "drive_channel", "url": "/api/qiskit/0.41/qiskit.pulse.builder.drive_channel" @@ -2990,10 +2982,6 @@ "title": "Gaussian", "url": "/api/qiskit/0.41/qiskit.pulse.library.Gaussian" }, - { - "title": "gaussian", - "url": "/api/qiskit/0.41/qiskit.pulse.library.gaussian" - }, { "title": "gaussian_deriv", "url": "/api/qiskit/0.41/qiskit.pulse.library.gaussian_deriv" diff --git a/docs/api/qiskit/0.41/aer.md b/docs/api/qiskit/0.41/aer.md index 0af76592643..46c89c11724 100644 --- a/docs/api/qiskit/0.41/aer.md +++ b/docs/api/qiskit/0.41/aer.md @@ -1,6 +1,6 @@ -# Qiskit Aer API Reference[¶](#qiskit-aer-api-reference "Permalink to this headline") +# Qiskit Aer API Reference * [Aer Provider (`qiskit_aer`)](aer_provider) * [Aer Jobs (`qiskit_aer.jobs`)](aer_jobs) diff --git a/docs/api/qiskit/0.41/aer_jobs.md b/docs/api/qiskit/0.41/aer_jobs.md index 3c28d5aa043..415fa7c4010 100644 --- a/docs/api/qiskit/0.41/aer_jobs.md +++ b/docs/api/qiskit/0.41/aer_jobs.md @@ -12,16 +12,12 @@ python_api_name: qiskit_aer.jobs -`qiskit_aer.jobs¶` +`qiskit_aer.jobs` This module contains classes and functions to manage Aer jobs. ## Classes - - -`¶` - The following are the classes used to manage job submissions. | | | diff --git a/docs/api/qiskit/0.41/aer_library.md b/docs/api/qiskit/0.41/aer_library.md index b5c5b3b6717..0e62d0ef40f 100644 --- a/docs/api/qiskit/0.41/aer_library.md +++ b/docs/api/qiskit/0.41/aer_library.md @@ -14,19 +14,15 @@ python_api_name: qiskit_aer.library -`qiskit_aer.library¶` +`qiskit_aer.library` This library contains custom qiskit `QuantumCircuit` [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") subclasses that can be used with the Aer circuit simulator backends. ## Setting a Custom Simulator State - - -`¶` - The following instruction classes can be used to set the specific simulator methods to a custom state. Note that these instructions are only valid when applied to all qubits in a circuit. Applying to a subset of qubits will raise an exception during execution. -### Instruction Classes[¶](#instruction-classes "Permalink to this headline") +### Instruction Classes | | | | --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | @@ -37,7 +33,7 @@ The following instruction classes can be used to set the specific simulator meth | [`SetUnitary`](qiskit_aer.library.SetUnitary "qiskit_aer.library.SetUnitary")(state) | Set unitary state of the simulator | | [`SetMatrixProductState`](qiskit_aer.library.SetMatrixProductState "qiskit_aer.library.SetMatrixProductState")(state) | Set the matrix product state of the simulator | -### QuantumCircuit Methods[¶](#quantumcircuit-methods "Permalink to this headline") +### QuantumCircuit Methods The set instructions can also be added to circuits by using the following `QuantumCircuit` methods which are patched when importing Aer. @@ -52,11 +48,7 @@ The set instructions can also be added to circuits by using the following `Quant ## Saving Simulator Data - - -`¶` - -### Simulator State Save Instruction Classes[¶](#simulator-state-save-instruction-classes "Permalink to this headline") +### Simulator State Save Instruction Classes The following instructions can be used to save the state of the simulator into the returned result object. The [`SaveState`](qiskit_aer.library.SaveState "qiskit_aer.library.SaveState") instruction will automatically select the format based on the simulation method (eg. [`SaveStatevector`](qiskit_aer.library.SaveStatevector "qiskit_aer.library.SaveStatevector") for statevector method, [`SaveDensityMatrix`](qiskit_aer.library.SaveDensityMatrix "qiskit_aer.library.SaveDensityMatrix") for density matrix method etc.). @@ -80,7 +72,7 @@ The following instructions can be used to save the state of the simulator into t The [`StatevectorSimulator`](qiskit_aer.StatevectorSimulator "qiskit_aer.StatevectorSimulator") (and [`UnitarySimulator`](qiskit_aer.UnitarySimulator "qiskit_aer.UnitarySimulator")) backend automatically append every run circuit with the a ``SaveStatevector`()`` (``SaveUnitary`()``) instruction using the default label. Hence adding any additional save instructions of that type will require specifying a custom label for those instructions. -### Simulator Derived Data Save Instruction Classes[¶](#simulator-derived-data-save-instruction-classes "Permalink to this headline") +### Simulator Derived Data Save Instruction Classes The following classes can be used to directly save data derived from the simulator state to the returned result object. One some are compatible with certain simulation methods. @@ -105,7 +97,7 @@ For convenience the save instructions can be accessed using custom `QuantumCircu In both these cases only a single shot is actually simulated and measurement samples for all shots are calculated from the final state. -### QuantumCircuit Methods[¶](#id1 "Permalink to this headline") +### QuantumCircuit Methods The save instructions can also be added to circuits by using the following `QuantumCircuit` methods which are patched when importing Aer. @@ -133,10 +125,6 @@ The save instructions can also be added to circuits by using the following `Quan ## Method Compatibility - - -`¶` - The following table summarizes which instructions are compatible with which simulation methods | Instruction | Automatic | Statevector | Density Matrix | MPS | Stabilizer | Ext. Stabilizer | Unitary | SuperOp | diff --git a/docs/api/qiskit/0.41/aer_noise.md b/docs/api/qiskit/0.41/aer_noise.md index f33d3efd12b..639ac1db11c 100644 --- a/docs/api/qiskit/0.41/aer_noise.md +++ b/docs/api/qiskit/0.41/aer_noise.md @@ -14,19 +14,15 @@ python_api_name: qiskit_aer.noise -`qiskit_aer.noise¶` +`qiskit_aer.noise` This module contains classes and functions to build a noise model for simulating a Qiskit quantum circuit in the presence of errors. ## Building Noise Models - - -`¶` - The [`NoiseModel`](qiskit_aer.noise.NoiseModel "qiskit_aer.noise.NoiseModel") class is used to represent noise model for the [`QasmSimulator`](qiskit_aer.QasmSimulator "qiskit_aer.QasmSimulator"). It can be used to construct custom noise models for simulator, to to automatically generate a basic device noise model for an IBMQ backend. -### Device Noise Models[¶](#device-noise-models "Permalink to this headline") +### Device Noise Models A simplified approximate [`NoiseModel`](qiskit_aer.noise.NoiseModel "qiskit_aer.noise.NoiseModel") can be generated automatically from the properties of real device backends from the IBMQ provider using the [`NoiseModel.from_backend()`](qiskit_aer.noise.NoiseModel#from_backend "qiskit_aer.noise.NoiseModel.from_backend") method. See the method documentation for details. @@ -65,7 +61,7 @@ counts = result.get_counts(0) plot_histogram(counts) ``` -### Custom Noise Models[¶](#custom-noise-models "Permalink to this headline") +### Custom Noise Models Custom noise models can be used by adding [`QuantumError`](qiskit_aer.noise.QuantumError "qiskit_aer.noise.QuantumError") to circuit gate, reset or measure instructions, and [`ReadoutError`](qiskit_aer.noise.ReadoutError "qiskit_aer.noise.ReadoutError") to measure instructions. This module includes several helper functions for generating [`QuantumError`](qiskit_aer.noise.QuantumError "qiskit_aer.noise.QuantumError") instances based on canonical error models used in Quantum Information Theory that can simplify building noise models. See the documentation for the [`NoiseModel`](qiskit_aer.noise.NoiseModel "qiskit_aer.noise.NoiseModel") class for additional details. @@ -109,10 +105,6 @@ plot_histogram(counts) ## Classes - - -`¶` - The following are the classes used to represented noise and error terms. | | | @@ -123,10 +115,6 @@ The following are the classes used to represented noise and error terms. ## Quantum Error Functions - - -`¶` - The following functions can be used to generate many common types of [`QuantumError`](qiskit_aer.noise.QuantumError "qiskit_aer.noise.QuantumError") objects for inclusion in a [`NoiseModel`](qiskit_aer.noise.NoiseModel "qiskit_aer.noise.NoiseModel"). | | | @@ -144,10 +132,6 @@ The following functions can be used to generate many common types of [`QuantumEr ## Noise Transpiler Passes - - -`¶` - These transpiler passes can be used to build noise models that can be applied to circuits via transpilation. | | | @@ -157,10 +141,6 @@ These transpiler passes can be used to build noise models that can be applied to ## Device Noise Parameters - - -`¶` - The following are utility functions which can be used for extracting error parameters and error objects from device BackendProperties. | | | diff --git a/docs/api/qiskit/0.41/aer_primitives.md b/docs/api/qiskit/0.41/aer_primitives.md index 81320a4943d..775bf0e9447 100644 --- a/docs/api/qiskit/0.41/aer_primitives.md +++ b/docs/api/qiskit/0.41/aer_primitives.md @@ -14,16 +14,12 @@ python_api_name: qiskit_aer.primitives -`qiskit_aer.primitives¶` +`qiskit_aer.primitives` This module is Aer implementation of primitives. See the docs [https://qiskit.org/documentation/apidoc/primitives.html](https://qiskit.org/documentation/apidoc/primitives.html) for general descriptions. ## Classes - - -`¶` - | | | | --------------------------------------------------------------------------------------------------------------- | ------------------------------------ | | [`Sampler`](qiskit_aer.primitives.Sampler "qiskit_aer.primitives.Sampler")(\[circuits, parameters, ...]) | Aer implementation of Sampler class. | diff --git a/docs/api/qiskit/0.41/aer_provider.md b/docs/api/qiskit/0.41/aer_provider.md index fb735bb3ace..a6992624269 100644 --- a/docs/api/qiskit/0.41/aer_provider.md +++ b/docs/api/qiskit/0.41/aer_provider.md @@ -12,24 +12,16 @@ python_api_name: qiskit_aer -`qiskit_aer¶` +`qiskit_aer` ## Simulator Provider - - -`¶` - | | | | ------------------------------------------------------------------ | --------------------------------- | | [`AerProvider`](qiskit_aer.AerProvider "qiskit_aer.AerProvider")() | Provider for Qiskit Aer backends. | ## Simulator Backends - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------ | ---------------------------------------- | | [`AerSimulator`](qiskit_aer.AerSimulator "qiskit_aer.AerSimulator")(\[configuration, properties, ...]) | Noisy quantum circuit simulator backend. | @@ -37,10 +29,6 @@ python_api_name: qiskit_aer ## Legacy Simulator Backends - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------- | | [`QasmSimulator`](qiskit_aer.QasmSimulator "qiskit_aer.QasmSimulator")(\[configuration, properties, ...]) | Noisy quantum circuit simulator backend. | @@ -49,10 +37,6 @@ python_api_name: qiskit_aer ## Exceptions - - -`¶` - | | | | ------------------------------------------------------------------ | ------------------------------------------- | | [`AerError`](qiskit_aer.AerError "qiskit_aer.AerError")(\*message) | Base class for errors raised by simulators. | diff --git a/docs/api/qiskit/0.41/aer_pulse.md b/docs/api/qiskit/0.41/aer_pulse.md index 6501720fc30..db3ff59f87d 100644 --- a/docs/api/qiskit/0.41/aer_pulse.md +++ b/docs/api/qiskit/0.41/aer_pulse.md @@ -14,26 +14,18 @@ python_api_name: qiskit_aer.pulse -`qiskit_aer.pulse¶` +`qiskit_aer.pulse` This module contains classes and functions to build a pulse system model for simulating a Qiskit pulse schedule. ## Classes - - -`¶` - | | | | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | | [`PulseSystemModel`](qiskit_aer.pulse.PulseSystemModel "qiskit_aer.pulse.PulseSystemModel")(\[hamiltonian, ...]) | Physical model object for pulse simulator. | ## Functions - - -`¶` - These functions can be used to generate a pulse system model for certain types of systems. | | | diff --git a/docs/api/qiskit/0.41/aer_quantum_info.md b/docs/api/qiskit/0.41/aer_quantum_info.md index 6860c240eac..3d29c7961b0 100644 --- a/docs/api/qiskit/0.41/aer_quantum_info.md +++ b/docs/api/qiskit/0.41/aer_quantum_info.md @@ -12,14 +12,10 @@ python_api_name: qiskit_aer.quantum_info -`qiskit_aer.quantum_info¶` +`qiskit_aer.quantum_info` ## States - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------ | -------------------- | | [`AerStatevector`](qiskit_aer.quantum_info.AerStatevector "qiskit_aer.quantum_info.AerStatevector")(data\[, dims]) | AerStatevector class | diff --git a/docs/api/qiskit/0.41/aer_utils.md b/docs/api/qiskit/0.41/aer_utils.md index 38e2e978a88..2dc9463402e 100644 --- a/docs/api/qiskit/0.41/aer_utils.md +++ b/docs/api/qiskit/0.41/aer_utils.md @@ -14,26 +14,18 @@ python_api_name: qiskit_aer.utils -`qiskit_aer.utils¶` +`qiskit_aer.utils` This module contains utility functions for modifying [`NoiseModel`](qiskit_aer.noise.NoiseModel "qiskit_aer.noise.NoiseModel") objects and `QuantumCircuits` using noise models. ## Classes - - -`¶` - | | | | --------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | [`NoiseTransformer`](qiskit_aer.utils.NoiseTransformer "qiskit_aer.utils.NoiseTransformer")() | \[Deprecated] Transforms one quantum channel to another based on a specified criteria. | ## Functions - - -`¶` - | | | | ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | | [`transform_noise_model`](qiskit_aer.utils.transform_noise_model "qiskit_aer.utils.transform_noise_model")(noise\_model, func) | Return a new noise model by applyign a function to all quantum errors. | diff --git a/docs/api/qiskit/0.41/algorithms.md b/docs/api/qiskit/0.41/algorithms.md index 12a322e6a2b..40c1d8ab62f 100644 --- a/docs/api/qiskit/0.41/algorithms.md +++ b/docs/api/qiskit/0.41/algorithms.md @@ -14,7 +14,7 @@ python_api_name: qiskit.algorithms -`qiskit.algorithms¶` +`qiskit.algorithms` It contains a collection of quantum algorithms, for use with quantum computers, to carry out research and investigate how to solve problems in different domains on near-term quantum devices with short depth circuits. @@ -24,13 +24,9 @@ Quantum algorithms are run via a `QuantumInstance` which must be set with the de ## Algorithms - - -`¶` - It contains a variety of quantum algorithms and these have been grouped by logical function such as minimum eigensolvers and amplitude amplifiers. -### Amplitude Amplifiers[¶](#amplitude-amplifiers "Permalink to this headline") +### Amplitude Amplifiers | | | | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | @@ -41,7 +37,7 @@ It contains a variety of quantum algorithms and these have been grouped by logic -### Amplitude Estimators[¶](#amplitude-estimators "Permalink to this headline") +### Amplitude Estimators | | | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | @@ -57,11 +53,11 @@ It contains a variety of quantum algorithms and these have been grouped by logic | [`MaximumLikelihoodAmplitudeEstimation`](qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation "qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation") | The Maximum Likelihood Amplitude Estimation algorithm. | | [`MaximumLikelihoodAmplitudeEstimationResult`](qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult "qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult") | The `MaximumLikelihoodAmplitudeEstimation` result object. | -### Eigensolvers[¶](#eigensolvers "Permalink to this headline") +### Eigensolvers Algorithms to find eigenvalues of an operator. For chemistry these can be used to find excited states of a molecule, and `qiskit-nature` has some algorithms that leverage chemistry specific knowledge to do this in that application domain. -#### Primitive-based Eigensolvers[¶](#primitive-based-eigensolvers "Permalink to this headline") +#### Primitive-based Eigensolvers These algorithms are based on the Qiskit Primitives, a new execution paradigm that replaces the use of [`QuantumInstance`](qiskit.utils.QuantumInstance "qiskit.utils.QuantumInstance") in algorithms. To ensure continued support and development, we recommend using the primitive-based Eigensolvers in place of the legacy [`QuantumInstance`](qiskit.utils.QuantumInstance "qiskit.utils.QuantumInstance")-based ones. @@ -69,7 +65,7 @@ These algorithms are based on the Qiskit Primitives, a new execution paradigm th | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | | [`eigensolvers`](qiskit.algorithms.eigensolvers#module-qiskit.algorithms.eigensolvers "qiskit.algorithms.eigensolvers") | Eigensolvers Package (qiskit.algorithms.eigensolvers) | -#### Legacy Eigensolvers[¶](#legacy-eigensolvers "Permalink to this headline") +#### Legacy Eigensolvers These algorithms, still based on the [`QuantumInstance`](qiskit.utils.QuantumInstance "qiskit.utils.QuantumInstance"), are superseded by the primitive-based versions in the section above but are still supported for now. @@ -81,11 +77,11 @@ These algorithms, still based on the [`QuantumInstance`](qiskit.utils.QuantumIns | [`VQD`](qiskit.algorithms.VQD "qiskit.algorithms.VQD") | Pending deprecation: Variational Quantum Deflation algorithm. | | [`VQDResult`](qiskit.algorithms.VQDResult "qiskit.algorithms.VQDResult") | Pending deprecation: VQD Result. | -### Time Evolvers[¶](#time-evolvers "Permalink to this headline") +### Time Evolvers Algorithms to evolve quantum states in time. Both real and imaginary time evolution is possible with algorithms that support them. For machine learning, Quantum Imaginary Time Evolution might be used to train Quantum Boltzmann Machine Neural Networks for example. -#### Primitive-based Time Evolvers[¶](#primitive-based-time-evolvers "Permalink to this headline") +#### Primitive-based Time Evolvers These algorithms are based on the Qiskit Primitives, a new execution paradigm that replaces the use of [`QuantumInstance`](qiskit.utils.QuantumInstance "qiskit.utils.QuantumInstance") in algorithms. To ensure continued support and development, we recommend using the primitive-based Time Evolvers in place of the legacy [`QuantumInstance`](qiskit.utils.QuantumInstance "qiskit.utils.QuantumInstance")-based ones. @@ -102,7 +98,7 @@ These algorithms are based on the Qiskit Primitives, a new execution paradigm th | [`VarQITE`](qiskit.algorithms.VarQITE "qiskit.algorithms.VarQITE") | Variational Quantum Imaginary Time Evolution algorithm. | | [`VarQRTE`](qiskit.algorithms.VarQRTE "qiskit.algorithms.VarQRTE") | Variational Quantum Real Time Evolution algorithm. | -#### Legacy Time Evolvers[¶](#legacy-time-evolvers "Permalink to this headline") +#### Legacy Time Evolvers These algorithms, still based on the [`QuantumInstance`](qiskit.utils.QuantumInstance "qiskit.utils.QuantumInstance"), are superseded by the primitive-based versions in the section above but are still supported for now. @@ -114,7 +110,7 @@ These algorithms, still based on the [`QuantumInstance`](qiskit.utils.QuantumIns | [`EvolutionResult`](qiskit.algorithms.EvolutionResult "qiskit.algorithms.EvolutionResult") | Pending deprecation: Class for holding evolution result. | | [`EvolutionProblem`](qiskit.algorithms.EvolutionProblem "qiskit.algorithms.EvolutionProblem") | Pending deprecation: Evolution problem class. | -#### Variational Quantum Time Evolution[¶](#variational-quantum-time-evolution "Permalink to this headline") +#### Variational Quantum Time Evolution Classes used by variational quantum time evolution algorithms - [`VarQITE`](qiskit.algorithms.VarQITE "qiskit.algorithms.VarQITE") and [`VarQRTE`](qiskit.algorithms.VarQRTE "qiskit.algorithms.VarQRTE"). @@ -122,7 +118,7 @@ Classes used by variational quantum time evolution algorithms - [`VarQITE`](qisk | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | [`time_evolvers.variational`](qiskit.algorithms.time_evolvers.variational#module-qiskit.algorithms.time_evolvers.variational "qiskit.algorithms.time_evolvers.variational") | Variational Quantum Time Evolutions (qiskit.algorithms.time\_evolvers.variational) | -#### Trotterization-based Quantum Real Time Evolution[¶](#trotterization-based-quantum-real-time-evolution "Permalink to this headline") +#### Trotterization-based Quantum Real Time Evolution Package for primitives-enabled Trotterization-based quantum time evolution algorithm - `TrotterQRTE`. @@ -130,7 +126,7 @@ Package for primitives-enabled Trotterization-based quantum time evolution algor | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | | [`time_evolvers.trotterization`](qiskit.algorithms.time_evolvers.trotterization#module-qiskit.algorithms.time_evolvers.trotterization "qiskit.algorithms.time_evolvers.trotterization") | This package contains Trotterization-based Quantum Real Time Evolution algorithm. | -### Factorizers[¶](#factorizers "Permalink to this headline") +### Factorizers Algorithms to find factors of a number. @@ -139,7 +135,7 @@ Algorithms to find factors of a number. | [`Shor`](qiskit.algorithms.Shor "qiskit.algorithms.Shor") | The deprecated Shor's factoring algorithm. | | [`ShorResult`](qiskit.algorithms.ShorResult "qiskit.algorithms.ShorResult") | The deprecated Shor Result. | -### Gradients[¶](#gradients "Permalink to this headline") +### Gradients Algorithms to calculate the gradient of a quantum circuit. @@ -147,7 +143,7 @@ Algorithms to calculate the gradient of a quantum circuit. | ----------------------------------------------------------------------------------------------------------- | --------------------------------------- | | [`gradients`](qiskit.algorithms.gradients#module-qiskit.algorithms.gradients "qiskit.algorithms.gradients") | Gradients (qiskit.algorithms.gradients) | -### Linear Solvers[¶](#linear-solvers "Permalink to this headline") +### Linear Solvers Algorithms to solve linear systems of equations. @@ -155,11 +151,11 @@ Algorithms to solve linear systems of equations. | ------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`linear_solvers`](qiskit.algorithms.linear_solvers#module-qiskit.algorithms.linear_solvers "qiskit.algorithms.linear_solvers") | The deprecated Linear solvers (qiskit.algorithms.linear\_solvers) It contains classical and quantum algorithms to solve systems of linear equations such as HHL. Although the quantum algorithm accepts a general Hermitian matrix as input, Qiskit's default Hamiltonian evolution is exponential in such cases and therefore the quantum linear solver will not achieve an exponential speedup. Furthermore, the quantum algorithm can find a solution exponentially faster in the size of the system than their classical counterparts (i.e. logarithmic complexity instead of polynomial), meaning that reading the full solution vector would kill such speedup (since this would take linear time in the size of the system). Therefore, to achieve an exponential speedup we can only compute functions from the solution vector (the so called observables) to learn information about the solution. Known efficient implementations of Hamiltonian evolutions or observables are contained in the following subfolders: | -### Minimum Eigensolvers[¶](#minimum-eigensolvers "Permalink to this headline") +### Minimum Eigensolvers Algorithms that can find the minimum eigenvalue of an operator. -#### Primitive-based Minimum Eigensolvers[¶](#primitive-based-minimum-eigensolvers "Permalink to this headline") +#### Primitive-based Minimum Eigensolvers These algorithms are based on the Qiskit Primitives, a new execution paradigm that replaces the use of [`QuantumInstance`](qiskit.utils.QuantumInstance "qiskit.utils.QuantumInstance") in algorithms. To ensure continued support and development, we recommend using the primitive-based Minimum Eigensolvers in place of the legacy [`QuantumInstance`](qiskit.utils.QuantumInstance "qiskit.utils.QuantumInstance")-based ones. @@ -167,7 +163,7 @@ These algorithms are based on the Qiskit Primitives, a new execution paradigm th | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | | [`minimum_eigensolvers`](qiskit.algorithms.minimum_eigensolvers#module-qiskit.algorithms.minimum_eigensolvers "qiskit.algorithms.minimum_eigensolvers") | Minimum Eigensolvers Package (qiskit.algorithms.minimum\_eigensolvers) | -#### Legacy Minimum Eigensolvers[¶](#legacy-minimum-eigensolvers "Permalink to this headline") +#### Legacy Minimum Eigensolvers These algorithms, still based on the [`QuantumInstance`](qiskit.utils.QuantumInstance "qiskit.utils.QuantumInstance"), are superseded by the primitive-based versions in the section above but are still supported for now. @@ -179,7 +175,7 @@ These algorithms, still based on the [`QuantumInstance`](qiskit.utils.QuantumIns | [`QAOA`](qiskit.algorithms.QAOA "qiskit.algorithms.QAOA") | Pending deprecation: Quantum Approximate Optimization Algorithm. | | [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE") | Pending deprecation: Variational Quantum Eigensolver algorithm. | -### Optimizers[¶](#optimizers "Permalink to this headline") +### Optimizers Classical optimizers for use by quantum variational algorithms. @@ -187,7 +183,7 @@ Classical optimizers for use by quantum variational algorithms. | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`optimizers`](qiskit.algorithms.optimizers#module-qiskit.algorithms.optimizers "qiskit.algorithms.optimizers") | Optimizers (qiskit.algorithms.optimizers) It contains a variety of classical optimizers for use by quantum variational algorithms, such as VQE. Logically, these optimizers can be divided into two categories: | -### Phase Estimators[¶](#phase-estimators "Permalink to this headline") +### Phase Estimators Algorithms that estimate the phases of eigenstates of a unitary. @@ -200,7 +196,7 @@ Algorithms that estimate the phases of eigenstates of a unitary. | [`PhaseEstimationResult`](qiskit.algorithms.PhaseEstimationResult "qiskit.algorithms.PhaseEstimationResult") | Store and manipulate results from running PhaseEstimation. | | [`IterativePhaseEstimation`](qiskit.algorithms.IterativePhaseEstimation "qiskit.algorithms.IterativePhaseEstimation") | Run the Iterative quantum phase estimation (QPE) algorithm. | -### State Fidelities[¶](#state-fidelities "Permalink to this headline") +### State Fidelities Algorithms that compute the fidelity of pairs of quantum states. @@ -208,13 +204,13 @@ Algorithms that compute the fidelity of pairs of quantum states. | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | | [`state_fidelities`](qiskit.algorithms.state_fidelities#module-qiskit.algorithms.state_fidelities "qiskit.algorithms.state_fidelities") | State Fidelity Interfaces (qiskit.algorithms.state\_fidelities) | -### Exceptions[¶](#exceptions "Permalink to this headline") +### Exceptions | | | | -------------------------------------------------------------------------------------------------- | ------------------------------ | | [`AlgorithmError`](qiskit.algorithms.AlgorithmError "qiskit.algorithms.AlgorithmError")(\*message) | For Algorithm specific errors. | -### Utility methods[¶](#utility-methods "Permalink to this headline") +### Utility methods Utility methods used by algorithms. @@ -223,7 +219,7 @@ Utility methods used by algorithms. | [`eval_observables`](qiskit.algorithms.eval_observables "qiskit.algorithms.eval_observables")(quantum\_instance, ...\[, ...]) | Pending deprecation: Accepts a list or a dictionary of operators and calculates their expectation values - means and standard deviations. | | [`estimate_observables`](qiskit.algorithms.estimate_observables "qiskit.algorithms.estimate_observables")(estimator, ...\[, ...]) | Accepts a sequence of operators and calculates their expectation values - means and metadata. | -### Utility classes[¶](#utility-classes "Permalink to this headline") +### Utility classes Utility classes used by algorithms (mainly for type-hinting purposes). diff --git a/docs/api/qiskit/0.41/assembler.md b/docs/api/qiskit/0.41/assembler.md index 9cc0338c421..2a1f209d298 100644 --- a/docs/api/qiskit/0.41/assembler.md +++ b/docs/api/qiskit/0.41/assembler.md @@ -14,44 +14,28 @@ python_api_name: qiskit.assembler -`qiskit.assembler¶` +`qiskit.assembler` ## Circuit Assembler - - -`¶` - | | | | -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | | [`assemble_circuits`](qiskit.assembler.assemble_circuits "qiskit.assembler.assemble_circuits")(circuits, run\_config, ...) | Assembles a list of circuits into a qobj that can be run on the backend. | ## Schedule Assembler - - -`¶` - | | | | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | [`assemble_schedules`](qiskit.assembler.assemble_schedules "qiskit.assembler.assemble_schedules")(schedules, qobj\_id, ...) | Assembles a list of schedules into a qobj that can be run on the backend. | ## Disassembler - - -`¶` - | | | | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | [`disassemble`](qiskit.assembler.disassemble "qiskit.assembler.disassemble")(qobj) | Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. | ## RunConfig - - -`¶` - | | | | --------------------------------------------------------------------------------------------------- | ---------------------------- | | [`RunConfig`](qiskit.assembler.RunConfig "qiskit.assembler.RunConfig")(\[shots, max\_credits, ...]) | Class for Run Configuration. | diff --git a/docs/api/qiskit/0.41/circuit.md b/docs/api/qiskit/0.41/circuit.md index d842aa8c648..4cda2af3957 100644 --- a/docs/api/qiskit/0.41/circuit.md +++ b/docs/api/qiskit/0.41/circuit.md @@ -14,14 +14,10 @@ python_api_name: qiskit.circuit -`qiskit.circuit¶` +`qiskit.circuit` ## Overview - - -`¶` - The fundamental element of quantum computing is the **quantum circuit**. A quantum circuit is a computational routine consisting of coherent quantum operations on quantum data, such as qubits. It is an ordered sequence of quantum gates, measurements and resets, which may be conditioned on real-time classical computation. A set of quantum gates is said to be universal if any unitary transformation of the quantum data can be efficiently approximated arbitrarily well as as sequence of gates in the set. Any quantum program can be represented by a sequence of quantum circuits and classical near-time computation. In Qiskit, this core element is represented by the [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") class. Below is an example of a quantum circuit that makes a three-qubit GHZ state defined as: @@ -48,10 +44,6 @@ circ.draw('mpl') ## Supplementary Information - - -`¶` - ### Quantum Circuit with conditionals When building a quantum circuit, there can be interest in applying a certain gate only if a classical register has a specific value. This can be done with the [`InstructionSet.c_if()`](qiskit.circuit.InstructionSet#c_if "qiskit.circuit.InstructionSet.c_if") method. @@ -203,11 +195,7 @@ qc.depth() ## Quantum Circuit API - - -`¶` - -### Quantum Circuit Construction[¶](#quantum-circuit-construction "Permalink to this headline") +### Quantum Circuit Construction | | | | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -220,7 +208,7 @@ qc.depth() | [`AncillaQubit`](qiskit.circuit.AncillaQubit "qiskit.circuit.AncillaQubit")(\[register, index]) | A qubit used as ancillary qubit. | | [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")(operation\[, qubits, clbits]) | A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), comprised of the `operation` and various operands. | -### Gates and Instructions[¶](#gates-and-instructions "Permalink to this headline") +### Gates and Instructions | | | | -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | @@ -232,7 +220,7 @@ qc.depth() | [`Operation`](qiskit.circuit.Operation "qiskit.circuit.Operation")() | Quantum Operation Interface Class. | | [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")(\*\[, base]) | A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. | -### Control Flow Operations[¶](#control-flow-operations "Permalink to this headline") +### Control Flow Operations | | | | --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -243,7 +231,7 @@ qc.depth() | [`BreakLoopOp`](qiskit.circuit.BreakLoopOp "qiskit.circuit.BreakLoopOp")(num\_qubits, num\_clbits\[, label]) | A circuit operation which, when encountered, jumps to the end of the nearest enclosing loop. | | [`ContinueLoopOp`](qiskit.circuit.ContinueLoopOp "qiskit.circuit.ContinueLoopOp")(num\_qubits, num\_clbits\[, label]) | A circuit operation which, when encountered, moves to the next iteration of the nearest enclosing loop. | -### Parametric Quantum Circuits[¶](#parametric-quantum-circuits "Permalink to this headline") +### Parametric Quantum Circuits | | | | ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | @@ -251,7 +239,7 @@ qc.depth() | [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector")(name\[, length]) | ParameterVector class to quickly generate lists of parameters. | | [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")(symbol\_map, expr) | ParameterExpression class to enable creating expressions of Parameters. | -### Random Circuits[¶](#random-circuits "Permalink to this headline") +### Random Circuits | | | | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | diff --git a/docs/api/qiskit/0.41/circuit_library.md b/docs/api/qiskit/0.41/circuit_library.md index a08ed2b3014..6d874f5e436 100644 --- a/docs/api/qiskit/0.41/circuit_library.md +++ b/docs/api/qiskit/0.41/circuit_library.md @@ -14,7 +14,7 @@ python_api_name: qiskit.circuit.library -`qiskit.circuit.library¶` +`qiskit.circuit.library` The circuit library is a collection of well-studied and valuable circuits, directives, and gates. We call them valuable for different reasons, for instance they can serve as building blocks for algorithms or they are circuits that we think are hard to simulate classically. @@ -36,10 +36,6 @@ The library is organized in several sections. ## Standard gates - - -`¶` - These operations are reversible unitary gates and they all subclass [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). As a consequence, they all have the methods [`to_matrix()`](qiskit.circuit.Gate#to_matrix "qiskit.circuit.Gate.to_matrix"), [`power()`](qiskit.circuit.Gate#power "qiskit.circuit.Gate.power"), and [`control()`](qiskit.circuit.Gate#control "qiskit.circuit.Gate.control"), which we can generally only apply to unitary operations. For example: @@ -118,10 +114,6 @@ print(gate.control(1).to_matrix()) # CX (controlled X) gate ## Standard Directives - - -`¶` - Directives are operations to the quantum stack that are meant to be interpreted by the backend or the transpiler. In general, the transpiler or backend might optionally ignore them if there is no implementation for them. | | | @@ -130,10 +122,6 @@ Directives are operations to the quantum stack that are meant to be interpreted ## Standard Operations - - -`¶` - Operations are non-reversible changes in the quantum state of the circuit. | | | @@ -143,10 +131,6 @@ Operations are non-reversible changes in the quantum state of the circuit. ## Generalized Gates - - -`¶` - These “gates” (many are [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") subclasses) allow to set the amount of qubits involved at instantiation time. ```python @@ -187,10 +171,6 @@ print(diagonal.num_qubits) ## Boolean Logic Circuits - - -`¶` - These are [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") subclasses that implement boolean logic operations, such as the logical or of a set of qubit states. | | | @@ -202,10 +182,6 @@ These are [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.Quant ## Basis Change Circuits - - -`¶` - These circuits allow basis transformations of the qubit states. For example, in the case of the Quantum Fourier Transform (QFT), it transforms between the computational basis and the Fourier basis. | | | @@ -214,19 +190,15 @@ These circuits allow basis transformations of the qubit states. For example, in ## Arithmetic Circuits - - -`¶` - These [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")s perform classical arithmetic, such as addition or multiplication. -### Amplitude Functions[¶](#amplitude-functions "Permalink to this headline") +### Amplitude Functions | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | [`LinearAmplitudeFunction`](qiskit.circuit.library.LinearAmplitudeFunction "qiskit.circuit.library.LinearAmplitudeFunction")(num\_state\_qubits, ...) | A circuit implementing a (piecewise) linear function on qubit amplitudes. | -### Functional Pauli Rotations[¶](#functional-pauli-rotations "Permalink to this headline") +### Functional Pauli Rotations | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------- | @@ -237,7 +209,7 @@ These [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCi | [`PiecewisePolynomialPauliRotations`](qiskit.circuit.library.PiecewisePolynomialPauliRotations "qiskit.circuit.library.PiecewisePolynomialPauliRotations")(\[...]) | Piecewise-polynomially-controlled Pauli rotations. | | [`PiecewiseChebyshev`](qiskit.circuit.library.PiecewiseChebyshev "qiskit.circuit.library.PiecewiseChebyshev")(f\_x\[, degree, ...]) | Piecewise Chebyshev approximation to an input function. | -### Adders[¶](#adders "Permalink to this headline") +### Adders | | | | ----------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | @@ -246,26 +218,26 @@ These [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCi | [`VBERippleCarryAdder`](qiskit.circuit.library.VBERippleCarryAdder "qiskit.circuit.library.VBERippleCarryAdder")(num\_state\_qubits\[, ...]) | The VBE ripple carry adder \[1]. | | [`WeightedAdder`](qiskit.circuit.library.WeightedAdder "qiskit.circuit.library.WeightedAdder")(\[num\_state\_qubits, weights, name]) | A circuit to compute the weighted sum of qubit registers. | -### Multipliers[¶](#multipliers "Permalink to this headline") +### Multipliers | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | [`HRSCumulativeMultiplier`](qiskit.circuit.library.HRSCumulativeMultiplier "qiskit.circuit.library.HRSCumulativeMultiplier")(num\_state\_qubits\[, ...]) | A multiplication circuit to store product of two input registers out-of-place. | | [`RGQFTMultiplier`](qiskit.circuit.library.RGQFTMultiplier "qiskit.circuit.library.RGQFTMultiplier")(num\_state\_qubits\[, ...]) | A QFT multiplication circuit to store product of two input registers out-of-place. | -### Comparators[¶](#comparators "Permalink to this headline") +### Comparators | | | | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | | [`IntegerComparator`](qiskit.circuit.library.IntegerComparator "qiskit.circuit.library.IntegerComparator")(\[num\_state\_qubits, value, ...]) | Integer Comparator. | -### Functions on binary variables[¶](#functions-on-binary-variables "Permalink to this headline") +### Functions on binary variables | | | | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | | [`QuadraticForm`](qiskit.circuit.library.QuadraticForm "qiskit.circuit.library.QuadraticForm")(\[num\_result\_qubits, ...]) | Implements a quadratic form on binary variables encoded in qubit registers. | -### Other arithmetic functions[¶](#other-arithmetic-functions "Permalink to this headline") +### Other arithmetic functions | | | | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | @@ -273,10 +245,6 @@ These [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCi ## Particular Quantum Circuits - - -`¶` - | | | | ----------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | [`FourierChecking`](qiskit.circuit.library.FourierChecking "qiskit.circuit.library.FourierChecking")(f, g) | Fourier checking circuit. | @@ -292,10 +260,6 @@ These [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCi ## N-local circuits - - -`¶` - These `BlueprintCircuit` subclasses are used as parameterized models (a.k.a. ansatzes or variational forms) in variational algorithms. They are heavily used in near-term algorithms in e.g. Chemistry, Physics or Optimization. | | | @@ -310,10 +274,6 @@ These `BlueprintCircuit` subclasses are used as parameterized models (a.k.a. ans ## Data encoding circuits - - -`¶` - These `BlueprintCircuit` encode classical data in quantum states and are used as feature maps for classification. | | | @@ -325,10 +285,6 @@ These `BlueprintCircuit` encode classical data in quantum states and are used as ## Template circuits - - -`¶` - Templates are functions that return circuits that compute the identity. They are used at circuit optimization where matching part of the template allows the compiler to replace the match with the inverse of the remainder from the template. In this example, the identity constant in a template is checked: @@ -345,7 +301,7 @@ data = Operator(template).data np.allclose(data, identity) # True, template_nct_4b_1 is the identity ``` -### NCT (Not-CNOT-Toffoli) template circuits[¶](#nct-not-cnot-toffoli-template-circuits "Permalink to this headline") +### NCT (Not-CNOT-Toffoli) template circuits Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"), [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"), and [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate") (Toffoli) gates. @@ -401,7 +357,7 @@ Template circuits for [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.lib | [`templates.nct.template_nct_9d_9`](qiskit.circuit.library.templates.nct.template_nct_9d_9 "qiskit.circuit.library.templates.nct.template_nct_9d_9")() | **returns**template as a quantum circuit. | | [`templates.nct.template_nct_9d_10`](qiskit.circuit.library.templates.nct.template_nct_9d_10 "qiskit.circuit.library.templates.nct.template_nct_9d_10")() | **returns**template as a quantum circuit. | -### Clifford template circuits[¶](#clifford-template-circuits "Permalink to this headline") +### Clifford template circuits Template circuits over Clifford gates. @@ -426,7 +382,7 @@ Template circuits over Clifford gates. | [`clifford_8_2`](qiskit.circuit.library.clifford_8_2 "qiskit.circuit.library.clifford_8_2")() | **returns**template as a quantum circuit. | | [`clifford_8_3`](qiskit.circuit.library.clifford_8_3 "qiskit.circuit.library.clifford_8_3")() | **returns**template as a quantum circuit. | -### RZXGate template circuits[¶](#rzxgate-template-circuits "Permalink to this headline") +### RZXGate template circuits Template circuits with [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). diff --git a/docs/api/qiskit/0.41/classicalfunction.md b/docs/api/qiskit/0.41/classicalfunction.md index 689b8a441aa..8b7679f9e81 100644 --- a/docs/api/qiskit/0.41/classicalfunction.md +++ b/docs/api/qiskit/0.41/classicalfunction.md @@ -14,14 +14,10 @@ python_api_name: qiskit.circuit.classicalfunction -`qiskit.circuit.classicalfunction¶` +`qiskit.circuit.classicalfunction` ## Overview - - -`¶` - The classical function compiler provides the necessary tools to map a classical irreversible functions into quantum circuits. Below is a simple example of how to synthesize a simple boolean function defined using Python into a QuantumCircuit: > ```python @@ -39,10 +35,6 @@ Following Qiskit’s little-endian bit ordering convention, the left-most bit (a ## Supplementary Information - - -`¶` - **Tweedledum** Tweedledum is a C++-17 header-only library that implements a large set of reversible (and quantum) synthesis, optimization, and mapping algorithms. The classical function compiler relies on it and its dependencies to both represent logic networks and synthesize them into quantum circuits. @@ -55,22 +47,18 @@ The type `Int1` means the classical function will only operate at bit level. ## ClassicalFunction compiler API - - -`¶` - -### classical\_function[¶](#classical-function "Permalink to this headline") +### classical\_function Decorator for a classical function that returns a ClassicalFunction object. -### ClassicalFunction[¶](#classicalfunction "Permalink to this headline") +### ClassicalFunction | | | | --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | | [`ClassicalFunction`](qiskit.circuit.classicalfunction.ClassicalFunction "qiskit.circuit.classicalfunction.ClassicalFunction")(source\[, name]) | Represent a classical function function and its logic network. | | [`BooleanExpression`](qiskit.circuit.classicalfunction.BooleanExpression "qiskit.circuit.classicalfunction.BooleanExpression")(expression\[, name]) | The Boolean Expression gate. | -### Exceptions[¶](#exceptions "Permalink to this headline") +### Exceptions | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | diff --git a/docs/api/qiskit/0.41/compiler.md b/docs/api/qiskit/0.41/compiler.md index 966bbfdee26..4bebf3e899f 100644 --- a/docs/api/qiskit/0.41/compiler.md +++ b/docs/api/qiskit/0.41/compiler.md @@ -14,14 +14,10 @@ python_api_name: qiskit.compiler -`qiskit.compiler¶` +`qiskit.compiler` ## Circuit and Pulse Compilation Functions - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | | [`assemble`](qiskit.compiler.assemble "qiskit.compiler.assemble")(experiments\[, backend, qobj\_id, ...]) | Assemble a list of circuits or pulse schedules into a `Qobj`. | diff --git a/docs/api/qiskit/0.41/converters.md b/docs/api/qiskit/0.41/converters.md index d62761c102d..70ae730a663 100644 --- a/docs/api/qiskit/0.41/converters.md +++ b/docs/api/qiskit/0.41/converters.md @@ -14,7 +14,7 @@ python_api_name: qiskit.converters -`qiskit.converters¶` +`qiskit.converters` | | | | -------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/api/qiskit/0.41/dagcircuit.md b/docs/api/qiskit/0.41/dagcircuit.md index d7b8a436d27..5adf8d9a980 100644 --- a/docs/api/qiskit/0.41/dagcircuit.md +++ b/docs/api/qiskit/0.41/dagcircuit.md @@ -14,14 +14,10 @@ python_api_name: qiskit.dagcircuit -`qiskit.dagcircuit¶` +`qiskit.dagcircuit` ## DAG Circuits - - -`¶` - | | | | ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")() | Quantum circuit as a directed acyclic graph. | @@ -34,10 +30,6 @@ python_api_name: qiskit.dagcircuit ## Block Collection - - -`¶` - | | | | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | | [`BlockCollector`](qiskit.dagcircuit.BlockCollector "qiskit.dagcircuit.BlockCollector")(dag) | Class for implementing block collection on a DAG. | @@ -45,10 +37,6 @@ python_api_name: qiskit.dagcircuit ## Exceptions - - -`¶` - | | | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | | [`DAGCircuitError`](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError")(\*msg) | Base class for errors raised by the DAGCircuit object. | diff --git a/docs/api/qiskit/0.41/execute.md b/docs/api/qiskit/0.41/execute.md index 8cf76b18dd8..577458a2e7d 100644 --- a/docs/api/qiskit/0.41/execute.md +++ b/docs/api/qiskit/0.41/execute.md @@ -14,11 +14,11 @@ python_api_name: qiskit.execute_function -`qiskit.execute_function¶` +`qiskit.execute_function` -`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)` +`execute(experiments, backend, basis_gates=None, coupling_map=None, backend_properties=None, initial_layout=None, seed_transpiler=None, optimization_level=None, pass_manager=None, qobj_id=None, qobj_header=None, shots=None, memory=None, max_credits=None, seed_simulator=None, default_qubit_los=None, default_meas_los=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, parameter_binds=None, schedule_circuit=False, inst_map=None, meas_map=None, scheduling_method=None, init_qubits=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/execute_function.py "view source code") Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. diff --git a/docs/api/qiskit/0.41/extensions.md b/docs/api/qiskit/0.41/extensions.md index dd92419702f..6915802245a 100644 --- a/docs/api/qiskit/0.41/extensions.md +++ b/docs/api/qiskit/0.41/extensions.md @@ -14,14 +14,10 @@ python_api_name: qiskit.extensions -`qiskit.extensions¶` +`qiskit.extensions` ## Unitary Extensions - - -`¶` - | | | | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | | [`UnitaryGate`](qiskit.extensions.UnitaryGate "qiskit.extensions.UnitaryGate")(data\[, label]) | Class quantum gates specified by a unitary matrix. | @@ -30,30 +26,18 @@ python_api_name: qiskit.extensions ## Simulator Extensions - - -`¶` - | | | | ----------------------------------------------------------------------------------------------------------------- | ------------------------------- | | [`Snapshot`](qiskit.extensions.Snapshot "qiskit.extensions.Snapshot")(label\[, snapshot\_type, num\_qubits, ...]) | Simulator snapshot instruction. | ## Initialization - - -`¶` - | | | | --------------------------------------------------------------------------------------------------- | --------------------------------- | | [`Initialize`](qiskit.extensions.Initialize "qiskit.extensions.Initialize")(params\[, num\_qubits]) | Complex amplitude initialization. | ## Uniformly Controlled Rotations - - -`¶` - | | | | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | | [`UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.UCPauliRotGate")(angle\_list, rot\_axis) | Uniformly controlled rotations (also called multiplexed rotations). | diff --git a/docs/api/qiskit/0.41/ibmq-provider.md b/docs/api/qiskit/0.41/ibmq-provider.md index b1e3c8caa26..0e65792843b 100644 --- a/docs/api/qiskit/0.41/ibmq-provider.md +++ b/docs/api/qiskit/0.41/ibmq-provider.md @@ -2,7 +2,7 @@ The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# Qiskit IBM Quantum Provider API Reference[¶](#qiskit-ibm-quantum-provider-api-reference "Permalink to this headline") +# Qiskit IBM Quantum Provider API Reference * [IBM Quantum Provider (`qiskit.providers.ibmq`)](ibmq_provider) * [Job (`qiskit.providers.ibmq.job`)](ibmq_job) diff --git a/docs/api/qiskit/0.41/ibmq_credentials.md b/docs/api/qiskit/0.41/ibmq_credentials.md index f4effdab7ea..096db18696e 100644 --- a/docs/api/qiskit/0.41/ibmq_credentials.md +++ b/docs/api/qiskit/0.41/ibmq_credentials.md @@ -18,26 +18,18 @@ python_api_name: qiskit.providers.ibmq.credentials -`qiskit.providers.ibmq.credentials¶` +`qiskit.providers.ibmq.credentials` Utilities for working with IBM Quantum Experience account credentials. ## Classes - - -`¶` - | | | | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | | [`Credentials`](qiskit.providers.ibmq.credentials.Credentials "qiskit.providers.ibmq.credentials.Credentials")(token, url\[, websockets\_url, ...]) | IBM Quantum Experience account credentials and preferences. | ## Exceptions - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | | [`CredentialsError`](qiskit.providers.ibmq.credentials.CredentialsError "qiskit.providers.ibmq.credentials.CredentialsError")(\*message) | Base class for errors raised during credential management. | diff --git a/docs/api/qiskit/0.41/ibmq_experiment.md b/docs/api/qiskit/0.41/ibmq_experiment.md index 4cf45e8300a..2aee67df48c 100644 --- a/docs/api/qiskit/0.41/ibmq_experiment.md +++ b/docs/api/qiskit/0.41/ibmq_experiment.md @@ -18,7 +18,7 @@ python_api_name: qiskit.providers.ibmq.experiment -`qiskit.providers.ibmq.experiment¶` +`qiskit.providers.ibmq.experiment` Modules related to IBM Quantum experiment service. @@ -40,10 +40,6 @@ This service is intended to be used in conjunction with the `qiskit-experiments` ## Classes - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | | [`IBMExperimentService`](qiskit.providers.ibmq.experiment.IBMExperimentService "qiskit.providers.ibmq.experiment.IBMExperimentService")(provider) | Provides experiment related services. | @@ -52,10 +48,6 @@ This service is intended to be used in conjunction with the `qiskit-experiments` ## Exceptions - - -`¶` - | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | | [`IBMExperimentError`](qiskit.providers.ibmq.experiment.IBMExperimentError "qiskit.providers.ibmq.experiment.IBMExperimentError")(\*message) | Base class for errors raised by the experiment service modules. | diff --git a/docs/api/qiskit/0.41/ibmq_job.md b/docs/api/qiskit/0.41/ibmq_job.md index 1863dcd512f..d155f5d9ce6 100644 --- a/docs/api/qiskit/0.41/ibmq_job.md +++ b/docs/api/qiskit/0.41/ibmq_job.md @@ -18,16 +18,12 @@ python_api_name: qiskit.providers.ibmq.job -`qiskit.providers.ibmq.job¶` +`qiskit.providers.ibmq.job` Modules representing IBM Quantum Experience jobs. ## Classes - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------- | | [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob")(backend, api\_client, job\_id, ...\[, ...]) | Representation of a job that executes on an IBM Quantum Experience backend. | @@ -35,20 +31,12 @@ Modules representing IBM Quantum Experience jobs. ## Functions - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------- | | [`job_monitor`](qiskit.providers.ibmq.job.job_monitor "qiskit.providers.ibmq.job.job_monitor")(job\[, interval, output]) | Monitor the status of an `IBMQJob` instance. | ## Exception - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- | | [`IBMQJobError`](qiskit.providers.ibmq.job.IBMQJobError "qiskit.providers.ibmq.job.IBMQJobError")(\*message) | Base class for errors raised by the job modules. | diff --git a/docs/api/qiskit/0.41/ibmq_jupyter.md b/docs/api/qiskit/0.41/ibmq_jupyter.md new file mode 100644 index 00000000000..ea736f13ff0 --- /dev/null +++ b/docs/api/qiskit/0.41/ibmq_jupyter.md @@ -0,0 +1,5 @@ + + The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) + + + diff --git a/docs/api/qiskit/0.41/ibmq_managed.md b/docs/api/qiskit/0.41/ibmq_managed.md index 6c60c4e2cb4..a45bbc12832 100644 --- a/docs/api/qiskit/0.41/ibmq_managed.md +++ b/docs/api/qiskit/0.41/ibmq_managed.md @@ -18,16 +18,12 @@ python_api_name: qiskit.providers.ibmq.managed -`qiskit.providers.ibmq.managed¶` +`qiskit.providers.ibmq.managed` High level mechanism for handling jobs. ## Classes - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | | [`IBMQJobManager`](qiskit.providers.ibmq.managed.IBMQJobManager "qiskit.providers.ibmq.managed.IBMQJobManager")() | Job Manager for IBM Quantum Experience. | @@ -37,10 +33,6 @@ High level mechanism for handling jobs. ## Exceptions - - -`¶` - | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | | [`IBMQJobManagerError`](qiskit.providers.ibmq.managed.IBMQJobManagerError "qiskit.providers.ibmq.managed.IBMQJobManagerError")(\*message) | Base class for errors raise by the Job Manager. | diff --git a/docs/api/qiskit/0.41/ibmq_provider.md b/docs/api/qiskit/0.41/ibmq_provider.md index 60e85b85d79..1d99c13dfd9 100644 --- a/docs/api/qiskit/0.41/ibmq_provider.md +++ b/docs/api/qiskit/0.41/ibmq_provider.md @@ -18,16 +18,12 @@ python_api_name: qiskit.providers.ibmq -`qiskit.providers.ibmq¶` +`qiskit.providers.ibmq` Modules representing the IBM Quantum Provider. ## Logging - - -`¶` - The IBM Quantum Provider uses the `qiskit.providers.ibmq` logger. Two environment variables can be used to control the logging: @@ -44,20 +40,12 @@ logging.getLogger('qiskit.providers.ibmq').setLevel(logging.WARNING) ## Functions - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------ | | [`least_busy`](qiskit.providers.ibmq.least_busy "qiskit.providers.ibmq.least_busy")(backends\[, reservation\_lookahead]) | Return the least busy backend from a list. | ## Classes - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | | [`AccountProvider`](qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider")(credentials, factory) | Provider for a single IBM Quantum Experience account. | @@ -69,10 +57,6 @@ logging.getLogger('qiskit.providers.ibmq').setLevel(logging.WARNING) ## Exceptions - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | | [`IBMQError`](qiskit.providers.ibmq.IBMQError "qiskit.providers.ibmq.IBMQError")(\*message) | Base class for errors raised by the provider modules. | diff --git a/docs/api/qiskit/0.41/ibmq_runtime.md b/docs/api/qiskit/0.41/ibmq_runtime.md index 68cd2709ed3..8fdc0cef9ef 100644 --- a/docs/api/qiskit/0.41/ibmq_runtime.md +++ b/docs/api/qiskit/0.41/ibmq_runtime.md @@ -18,7 +18,7 @@ python_api_name: qiskit.providers.ibmq.runtime -`qiskit.providers.ibmq.runtime¶` +`qiskit.providers.ibmq.runtime` Modules related to Qiskit Runtime Service. @@ -51,10 +51,6 @@ The Qiskit Runtime Service allows authorized users to upload their Qiskit quantu ## Listing runtime programs - - -`¶` - To list all available runtime programs: ```python @@ -76,10 +72,6 @@ In the example above, `provider.runtime` points to the runtime service class [`I ## Invoking a runtime program - - -`¶` - You can use the [`IBMRuntimeService.run()`](qiskit.providers.ibmq.runtime.IBMRuntimeService#run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run") method to invoke a runtime program. For example: ```python @@ -117,18 +109,10 @@ The example above invokes the `circuit-runner` program, which compiles, executes ## Runtime Jobs - - -`¶` - When you use the [`IBMRuntimeService.run()`](qiskit.providers.ibmq.runtime.IBMRuntimeService#run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run") method to invoke a runtime program, a [`RuntimeJob`](qiskit.providers.ibmq.runtime.RuntimeJob "qiskit.providers.ibmq.runtime.RuntimeJob") instance is returned. This class has all the basic job methods, such as [`RuntimeJob.status()`](qiskit.providers.ibmq.runtime.RuntimeJob#status "qiskit.providers.ibmq.runtime.RuntimeJob.status"), [`RuntimeJob.result()`](qiskit.providers.ibmq.runtime.RuntimeJob#result "qiskit.providers.ibmq.runtime.RuntimeJob.result"), and [`RuntimeJob.cancel()`](qiskit.providers.ibmq.runtime.RuntimeJob#cancel "qiskit.providers.ibmq.runtime.RuntimeJob.cancel"). Note that it does not have the same methods as regular circuit jobs, which are instances of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob"). ## Interim results - - -`¶` - Some runtime programs provide interim results that inform you about program progress. You can choose to stream the interim results when you run the program by passing in the `callback` parameter, or at a later time using the [`RuntimeJob.stream_results()`](qiskit.providers.ibmq.runtime.RuntimeJob#stream_results "qiskit.providers.ibmq.runtime.RuntimeJob.stream_results") method. For example: ```python @@ -149,10 +133,6 @@ job = provider.runtime.run(program_id="circuit-runner", ## Uploading a program - - -`¶` - Only authorized accounts can upload programs. Having access to the runtime service doesn’t imply access to upload programs. @@ -181,7 +161,7 @@ Method [`IBMRuntimeService.delete_program()`](qiskit.providers.ibmq.runtime.IBMR Files related to writing a runtime program are in the `qiskit/providers/ibmq/runtime/program` directory. -### Classes[¶](#classes "Permalink to this headline") +### Classes | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | diff --git a/docs/api/qiskit/0.41/ibmq_utils.md b/docs/api/qiskit/0.41/ibmq_utils.md index 3bf4d1c49f1..1efaaa1d538 100644 --- a/docs/api/qiskit/0.41/ibmq_utils.md +++ b/docs/api/qiskit/0.41/ibmq_utils.md @@ -18,16 +18,12 @@ python_api_name: qiskit.providers.ibmq.utils -`qiskit.providers.ibmq.utils¶` +`qiskit.providers.ibmq.utils` Utility functions related to the IBM Quantum Provider. ## Conversion - - -`¶` - | | | | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | [`seconds_to_duration`](qiskit.providers.ibmq.utils.seconds_to_duration "qiskit.providers.ibmq.utils.seconds_to_duration")(seconds) | Converts seconds in a datetime delta to a duration. | @@ -35,20 +31,12 @@ Utility functions related to the IBM Quantum Provider. ## Qobj Utils - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | | [`update_qobj_config`](qiskit.providers.ibmq.utils.update_qobj_config "qiskit.providers.ibmq.utils.update_qobj_config")(qobj\[, backend\_options, ...]) | Update a `Qobj` configuration from backend options and a noise model. | ## Misc Functions - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------- | | [`to_python_identifier`](qiskit.providers.ibmq.utils.to_python_identifier "qiskit.providers.ibmq.utils.to_python_identifier")(name) | Convert a name to a valid Python identifier. | diff --git a/docs/api/qiskit/0.41/ibmq_visualization.md b/docs/api/qiskit/0.41/ibmq_visualization.md new file mode 100644 index 00000000000..5109a4a40ab --- /dev/null +++ b/docs/api/qiskit/0.41/ibmq_visualization.md @@ -0,0 +1,5 @@ + + The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) + + + diff --git a/docs/api/qiskit/0.41/index.md b/docs/api/qiskit/0.41/index.md index a4ec07c9536..e658a16471f 100644 --- a/docs/api/qiskit/0.41/index.md +++ b/docs/api/qiskit/0.41/index.md @@ -10,10 +10,6 @@ python_api_name: qiskit # Qiskit Terra API Reference - - -`¶` - * [Quantum Circuits (`qiskit.circuit`)](circuit) * [Circuit Library (`qiskit.circuit.library`)](circuit_library) * [Compilation Routines (`qiskit.compiler`)](compiler) diff --git a/docs/api/qiskit/0.41/opflow.md b/docs/api/qiskit/0.41/opflow.md index bc71cdbb0d3..243527d6d72 100644 --- a/docs/api/qiskit/0.41/opflow.md +++ b/docs/api/qiskit/0.41/opflow.md @@ -14,7 +14,7 @@ python_api_name: qiskit.opflow -`qiskit.opflow¶` +`qiskit.opflow` Operators and State functions are the building blocks of Quantum Algorithms. @@ -40,10 +40,6 @@ Below, you’ll find a base class for all Operators, some convenience immutable ## Operator Base Class - - -`¶` - The OperatorBase serves as the base class for all Operators, State functions and measurements, and enforces the presence and consistency of methods to manipulate these objects conveniently. | | | @@ -52,10 +48,6 @@ The OperatorBase serves as the base class for all Operators, State functions and ## Operator Globals - - -`¶` - The `operator_globals` is a set of immutable Operator instances that are convenient building blocks to reach for while working with the Operator flow. **One qubit Pauli operators:** @@ -72,11 +64,7 @@ The `operator_globals` is a set of immutable Operator instances that are conveni ## Submodules - - -`¶` - -### Operators[¶](#operators "Permalink to this headline") +### Operators The Operators submodules include the PrimitiveOp, ListOp, and StateFn class groups which represent the primary Operator modules. @@ -86,7 +74,7 @@ The Operators submodules include the PrimitiveOp, ListOp, and StateFn class grou | [`list_ops`](qiskit.opflow.list_ops#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops") | List Operators (qiskit.opflow\.list\_ops) | | [`state_fns`](qiskit.opflow.state_fns#module-qiskit.opflow.state_fns "qiskit.opflow.state_fns") | State Functions (qiskit.opflow\.state\_fns) | -### Converters[¶](#converters "Permalink to this headline") +### Converters The Converter submodules include objects which manipulate Operators, usually recursing over an Operator structure and changing certain Operators’ representation. For example, the [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") traverses an Operator structure, and replaces all of the [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements containing non-diagonal Pauli terms into diagonalizing circuits following by [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurement containing only diagonal Paulis. @@ -99,10 +87,6 @@ The Converter submodules include objects which manipulate Operators, usually rec ## Utility functions - - -`¶` - | | | | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | | [`commutator`](qiskit.opflow.commutator "qiskit.opflow.commutator")(op\_a, op\_b) | Compute commutator of op\_a and op\_b. | @@ -111,10 +95,6 @@ The Converter submodules include objects which manipulate Operators, usually rec ## Exceptions - - -`¶` - | | | | --------------------------------------------------------------------------------- | --------------------------- | | [`OpflowError`](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError")(\*message) | For Opflow specific errors. | diff --git a/docs/api/qiskit/0.41/parallel.md b/docs/api/qiskit/0.41/parallel.md index bd896a0be99..b6741bda4b5 100644 --- a/docs/api/qiskit/0.41/parallel.md +++ b/docs/api/qiskit/0.41/parallel.md @@ -1,10 +1,10 @@ -# Running with Threadpool and DASK[¶](#running-with-threadpool-and-dask "Permalink to this headline") +# Running with Threadpool and DASK Qiskit Aer runs simulation jobs on a single-worker Python multiprocessing ThreadPool executor so that all parallelization is handled by low-level OpenMP and CUDA code. However to customize job-level parallel execution of multiple circuits a user can specify a custom multiprocessing executor and control the splitting of circuits using the `executor` and `max_job_size` backend options. For large scale job parallelization on HPC clusters Qiskit Aer executors support the distributed Clients from the [DASK](http://dask.org). -## Installation of DASK packages with Aer[¶](#installation-of-dask-packages-with-aer "Permalink to this headline") +## Installation of DASK packages with Aer If you want to install dask client at the same time as Qiskit Aer, please add the `dask` extra as follows. This option installs Aer, dask, and distributed packages. @@ -12,11 +12,11 @@ If you want to install dask client at the same time as Qiskit Aer, please add th pip install .[dask] ``` -## Usage of executor[¶](#usage-of-executor "Permalink to this headline") +## Usage of executor To use Threadpool or DASK as an executor, you need to set `executor` and `max_job_size` by `set_options` function. If both `executor` (default None) and `max_job_size` (default None) are set, Aer splits the multiple circuits to some chunk of circuits and submits them to the executor. `max_job_size` can control the number of splitting circuits. When `max_job_size` is set to 1, multiple circuits are split into one circuit and distributed to the executor. If a user executes 60 circuits with the executor and `max_job_size=1`, Aer splits it as 60 jobs each of 1 circuit. If there are 60 circuits and `max_job_size=2`, Aer splits it as 30 jobs, each with 2 circuits. -### Example: Threadpool execution[¶](#example-threadpool-execution "Permalink to this headline") +### Example: Threadpool execution ```python import qiskit @@ -48,7 +48,7 @@ qbackend.set_options(max_job_size=1) result = qbackend.run(circ_list).result() ``` -### Example: Dask execution[¶](#example-dask-execution "Permalink to this headline") +### Example: Dask execution The Dask client uses `multiprocessing` so you need to guard it by an `if __name__ == "__main__":` block. diff --git a/docs/api/qiskit/0.41/primitives.md b/docs/api/qiskit/0.41/primitives.md index 5e83c860279..e15e50a4af1 100644 --- a/docs/api/qiskit/0.41/primitives.md +++ b/docs/api/qiskit/0.41/primitives.md @@ -16,14 +16,10 @@ python_api_name: qiskit.primitives -`qiskit.primitives¶` +`qiskit.primitives` ## Overview of Estimator - - -`¶` - Estimator class estimates expectation values of quantum circuits and observables. An estimator is initialized with an empty parameter set. The estimator is used to create a [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.JobV1"), via the [`qiskit.primitives.Estimator.run()`](qiskit.primitives.Estimator#run "qiskit.primitives.Estimator.run") method. This method is called with the following parameters @@ -75,10 +71,6 @@ print(f"The primitive-job finished with result {job_result}") ## Overview of Sampler - - -`¶` - Sampler class calculates probabilities or quasi-probabilities of bitstrings from quantum circuits. A sampler is initialized with an empty parameter set. The sampler is used to create a [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.JobV1"), via the [`qiskit.primitives.Sampler.run()`](qiskit.primitives.Sampler#run "qiskit.primitives.Sampler.run") method. This method is called with the following parameters @@ -129,10 +121,6 @@ print([q.binary_probabilities() for q in job_result.quasi_dists]) ## Estimator - - -`¶` - | | | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | | [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.BaseEstimator")(\[circuits, observables, ...]) | Estimator base class. | @@ -141,10 +129,6 @@ print([q.binary_probabilities() for q in job_result.quasi_dists]) ## Sampler - - -`¶` - | | | | ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.BaseSampler")(\[circuits, parameters, options]) | Sampler base class | @@ -153,10 +137,6 @@ print([q.binary_probabilities() for q in job_result.quasi_dists]) ## Results - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------ | -------------------- | | [`EstimatorResult`](qiskit.primitives.EstimatorResult "qiskit.primitives.EstimatorResult")(values, metadata) | Result of Estimator. | diff --git a/docs/api/qiskit/0.41/providers.md b/docs/api/qiskit/0.41/providers.md index 4cb83e3b327..ef51266a8c5 100644 --- a/docs/api/qiskit/0.41/providers.md +++ b/docs/api/qiskit/0.41/providers.md @@ -14,23 +14,19 @@ python_api_name: qiskit.providers -`qiskit.providers¶` +`qiskit.providers` This module contains the classes used to build external providers for Terra. A provider is anything that provides an external service to Terra. The typical example of this is a Backend provider which provides [`Backend`](qiskit.providers.Backend "qiskit.providers.Backend") objects which can be used for executing [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") and/or [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") objects. This module contains the abstract classes which are used to define the interface between a provider and terra. ## Version Support - - -`¶` - Each providers interface abstract class is individually versioned. When we need to make a change to an interface a new abstract class will be created to define the new interface. These interface changes are not guaranteed to be backwards compatible between versions. -### Version Changes[¶](#version-changes "Permalink to this headline") +### Version Changes Each minor version release of qiskit-terra **may** increment the version of any providers interface a single version number. It will be an aggregate of all the interface changes for that release on that interface. -### Version Support Policy[¶](#version-support-policy "Permalink to this headline") +### Version Support Policy To enable providers to have time to adjust to changes in this interface Terra will support support multiple versions of each class at once. Given the nature of one version per release the version deprecation policy is a bit more conservative than the standard deprecation policy. Terra will support a provider interface version for a minimum of 3 minor releases or the first release after 6 months from the release that introduced a version, whichever is longer, prior to a potential deprecation. After that the standard deprecation policy will apply to that interface version. This will give providers and users sufficient time to adapt to potential breaking changes in the interface. So for example lets say in 0.19.0 `BackendV2` is introduced and in the 3 months after the release of 0.19.0 we release 0.20.0, 0.21.0, and 0.22.0, then 7 months after 0.19.0 we release 0.23.0. In 0.23.0 we can deprecate BackendV2, and it needs to still be supported and can’t be removed until the deprecation policy completes. @@ -38,18 +34,14 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p ## Abstract Classes - - -`¶` - -### Provider[¶](#provider "Permalink to this headline") +### Provider | | | | --------------------------------------------------------------------------- | ------------------------------------------------------------- | | [`Provider`](qiskit.providers.Provider "qiskit.providers.Provider")() | Base common type for all versioned Provider abstract classes. | | [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.ProviderV1")() | Base class for a Backend Provider. | -### Backend[¶](#backend "Permalink to this headline") +### Backend | | | | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | @@ -60,26 +52,26 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p | [`BackendV2Converter`](qiskit.providers.BackendV2Converter "qiskit.providers.BackendV2Converter")(backend\[, name\_mapping, ...]) | A converter class that takes a [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.BackendV1") instance and wraps it in a [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") interface. | | [`convert_to_target`](qiskit.providers.convert_to_target "qiskit.providers.convert_to_target")(configuration\[, ...]) | Uses configuration, properties and pulse defaults to construct and return Target class. | -### Options[¶](#options "Permalink to this headline") +### Options | | | | ---------------------------------------------------------------------------- | ------------------- | | [`Options`](qiskit.providers.Options "qiskit.providers.Options")(\*\*kwargs) | Base options object | -### Job[¶](#job "Permalink to this headline") +### Job | | | | ---------------------------------------------------------------------------------------- | -------------------------------------------------------- | | [`Job`](qiskit.providers.Job "qiskit.providers.Job")() | Base common type for all versioned Job abstract classes. | | [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.JobV1")(backend, job\_id, \*\*kwargs) | Class to handle jobs | -### Job Status[¶](#job-status "Permalink to this headline") +### Job Status | | | | ----------------------------------------------------------------------------- | ------------------------------------- | | [`JobStatus`](qiskit.providers.JobStatus "qiskit.providers.JobStatus")(value) | Class for job status enumerated type. | -### Exceptions[¶](#exceptions "Permalink to this headline") +### Exceptions | | | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------ | @@ -90,10 +82,6 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p # Writing a New Provider - - -`¶` - If you have a quantum device or simulator that you would like to integrate with Qiskit you will need to write a provider. A provider will provide Terra with a method to get available [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") objects. The [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") object provides both information describing a backend and its operation for the [`transpiler`](transpiler#module-qiskit.transpiler "qiskit.transpiler") so that circuits can be compiled to something that is optimized and can execute on the backend. It also provides the [`run()`](qiskit.providers.BackendV2#run "qiskit.providers.BackendV2.run") method which can run the [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects and/or [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") objects. This enables users and other Qiskit APIs, such as [`execute()`](execute#qiskit.execute_function.execute "qiskit.execute_function.execute") and higher level algorithms in [`qiskit.algorithms`](algorithms#module-qiskit.algorithms "qiskit.algorithms"), to get results from executing circuits on devices in a standard fashion regardless of how the backend is implemented. At a high level the basic steps for writing a provider are: > * Implement a [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.ProviderV1") subclass that handles access to the backend(s). @@ -108,10 +96,6 @@ For a simple example of a provider, see the [qiskit-aqt-provider](https://github ## Provider - - -`¶` - A provider class serves a single purpose: to get backend objects that enable executing circuits on a device or simulator. The expectation is that any required credentials and/or authentication will be handled in the initialization of a provider object. The provider object will then provide a list of backends, and methods to filter and acquire backends (using the provided credentials if required). An example provider class looks like: ```python @@ -138,10 +122,6 @@ Ensure that any necessary information for authentication (if required) are prese ## Backend - - -`¶` - The backend classes are the core to the provider. These classes are what provide the interface between Qiskit and the hardware or simulator that will execute circuits. This includes providing the necessary information to describe a backend to the compiler so that it can embed and optimize any circuit for the backend. There are 4 required things in every backend object: a [`target`](qiskit.providers.BackendV2#target "qiskit.providers.BackendV2.target") property to define the model of the backend for the compiler, a [`max_circuits`](qiskit.providers.BackendV2#max_circuits "qiskit.providers.BackendV2.max_circuits") property to define a limit on the number of circuits the backend can execute in a single batch job (if there is no limit `None` can be used), a [`run()`](qiskit.providers.BackendV2#run "qiskit.providers.BackendV2.run") method to accept job submissions, and a `_default_options` method to define the user configurable options and their default values. For example, a minimum working example would be something like: ```python @@ -210,11 +190,11 @@ class Mybackend(Backend): return MyJob(self. job_handle, job_json, circuit) ``` -### Transpiler Interface[¶](#transpiler-interface "Permalink to this headline") +### Transpiler Interface The key piece of the [`Backend`](qiskit.providers.Backend "qiskit.providers.Backend") object is how it describes itself to the compiler. This is handled with the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") class which defines a model of a backend for the transpiler. A backend object will need to return a [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") object from the [`target`](qiskit.providers.BackendV2#target "qiskit.providers.BackendV2.target") attribute which the [`transpile()`](qiskit.compiler.transpile "qiskit.compiler.transpile") function will use as its model of a backend target for compilation. -#### Custom Basis Gates[¶](#custom-basis-gates "Permalink to this headline") +#### Custom Basis Gates 1. If your backend doesn’t use gates in the Qiskit circuit library ([`qiskit.circuit.library`](circuit_library#module-qiskit.circuit.library "qiskit.circuit.library")) you can integrate support for this into your provider. The basic method for doing this is first to define a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") subclass for each custom gate in the basis set. For example: @@ -290,7 +270,7 @@ The key piece of the [`Backend`](qiskit.providers.Backend "qiskit.providers.Back -#### Custom Transpiler Passes[¶](#custom-transpiler-passes "Permalink to this headline") +#### Custom Transpiler Passes The transpiler supports the ability for backends to provide custom transpiler stage implementations to facilitate hardware specific optimizations and circuit transformations. Currently there are two stages supported, `get_translation_stage_plugin()` and `get_scheduling_stage_plugin()` which allow a backend to specify string plugin names to be used as the default translation and scheduling stages, respectively. These hook points in a [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") class can be used if your backend has requirements for compilation that are not met by the current backend/[`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") interface. Please also consider submitting a Github issue describing your use case as there is interest in improving these interfaces to be able to describe more hardware architectures in greater depth. @@ -310,7 +290,7 @@ This snippet of a backend implementation will now have the [`transpile()`](qiski This way if these two compilation steps are **required** for running or providing efficient output on `Mybackend` the transpiler will be able to perform these custom steps without any manual user input. -### Run Method[¶](#run-method "Permalink to this headline") +### Run Method Of key importance is the [`run()`](qiskit.providers.BackendV2#run "qiskit.providers.BackendV2.run") method, which is used to actually submit circuits to a device or simulator. The run method handles submitting the circuits to the backend to be executed and returning a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object. Depending on the type of backend this typically involves serializing the circuit object into the API format used by a backend. For example, on IBMQ backends from the `qiskit-ibmq-provider` package this involves converting from a quantum circuit and options into a [qobj](https://arxiv.org/abs/1809.03452) JSON payload and submitting that to the IBM Quantum API. Since every backend interface is different (and in the case of the local simulators serialization may not be needed) it is expected that the backend’s [`run`](qiskit.providers.BackendV2#run "qiskit.providers.BackendV2.run") method will handle this conversion. @@ -332,7 +312,7 @@ def run(self, circuits. **kwargs): return MyJob(self. job_handle, job_json, circuit) ``` -### Options[¶](#id3 "Permalink to this headline") +### Options There are often several options for a backend that control how a circuit is run. The typical example of this is something like the number of `shots` which is how many times the circuit is to be executed. The options available for a backend are defined using an [`Options`](qiskit.providers.Options "qiskit.providers.Options") object. This object is initially created by the `_default_options` method of a Backend class. The default options returns an initialized [`Options`](qiskit.providers.Options "qiskit.providers.Options") object with all the default values for all the options a backend supports. For example, if the backend supports only supports `shots` the `_default_options` method would look like: @@ -352,10 +332,6 @@ you can refer to the [`set_validator()`](qiskit.providers.Options#set_validator ## Job - - -`¶` - The output from the [`run`](qiskit.providers.BackendV2#run "qiskit.providers.BackendV2.run") method is a [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.JobV1") object. Each provider is expected to implement a custom job subclass that defines the behavior for the provider. There are 2 types of jobs depending on the backend’s execution method, either a sync or async. By default jobs are considered async and the expectation is that it represents a handle to the async execution of the circuits submitted with `Backend.run()`. An async job object provides users the ability to query the status of the execution, cancel a running job, and block until the execution is finished. The [`result`](qiskit.providers.JobV1#result "qiskit.providers.JobV1.result") is the primary user facing method which will block until the execution is complete and then will return a [`Result`](qiskit.result.Result "qiskit.result.Result") object with results of the job. For some backends (mainly local simulators) the execution of circuits is a synchronous operation and there is no need to return a handle to a running job elsewhere. For sync jobs its expected that the [`run`](qiskit.providers.BackendV1#run "qiskit.providers.BackendV1.run") method on the backend will block until a [`Result`](qiskit.result.Result "qiskit.result.Result") object is generated and the sync job will return with that inner [`Result`](qiskit.result.Result "qiskit.result.Result") object. @@ -441,26 +417,14 @@ class MySyncJob(Job): ## Primitives - - -`¶` - While not directly part of the provider interface, the [`qiskit.primitives`](primitives#module-qiskit.primitives "qiskit.primitives") module is tightly coupled with providers. Specifically the primitive interfaces, such as [`BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.BaseSampler") and [`BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.BaseEstimator"), are designed to enable provider implementations to provide custom implementations which are optimized for the provider’s backends. This can include customizations like circuit transformations, additional pre- and post-processing, batching, caching, error mitigation, etc. The concept of the [`qiskit.primitives`](primitives#module-qiskit.primitives "qiskit.primitives") module is to explicitly enable this as the primitive objects are higher level abstractions to produce processed higher level outputs (such as probability distributions and expectation values) that abstract away the mechanics of getting the best result efficienctly, to concentrate on higher level applications using these outputs. For example, if your backends were well suited to leverage [mthree](https://github.com/Qiskit-Partners/mthree/) measurement mitigation to improve the quality of the results, you could implement a provider-specific [`Sampler`](qiskit.primitives.Sampler "qiskit.primitives.Sampler") implementation that leverages the `M3Mitigation` class internally to run the circuits and return quasi-probabilities directly from mthree in the result. Doing this would enable algorithms from [`qiskit.algorithms`](algorithms#module-qiskit.algorithms "qiskit.algorithms") to get the best results with mitigation applied directly from your backends. You can refer to the documentation in [`qiskit.primitives`](primitives#module-qiskit.primitives "qiskit.primitives") on how to write custom implementations. Also the built-in implementations: [`Sampler`](qiskit.primitives.Sampler "qiskit.primitives.Sampler"), [`Estimator`](qiskit.primitives.Estimator "qiskit.primitives.Estimator"), [`BackendSampler`](qiskit.primitives.BackendSampler "qiskit.primitives.BackendSampler"), and [`BackendEstimator`](qiskit.primitives.BackendEstimator "qiskit.primitives.BackendEstimator") can serve as references/models on how to implement these as well. # Migrating between Backend API Versions - - -`¶` - ## BackendV1 -> BackendV2 - - -`¶` - The [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") class re-defined user access for most properties of a backend to make them work with native Qiskit data structures and have flatter access patterns. However this means when using a provider that upgrades from [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.BackendV1") to [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") existing access patterns will need to be adjusted. It is expected for existing providers to deprecate the old access where possible to provide a graceful migration, but eventually users will need to adjust code. The biggest change to adapt to in [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") is that most of the information accesible about a backend is contained in its [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") object and the backend’s attributes often query its [`target`](qiskit.providers.BackendV2#target "qiskit.providers.BackendV2.target") attribute to return information, however in many cases the attributes only provide a subset of information the target can contain. For example, `backend.coupling_map` returns a [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") constructed from the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") accesible in the [`target`](qiskit.providers.BackendV2#target "qiskit.providers.BackendV2.target") attribute, however the target may contain instructions that operate on more than two qubits (which can’t be represented in a [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) or has instructions that only operate on a subset of qubits (or two qubit links for a two qubit instruction) which won’t be detailed in the full coupling map returned by [`coupling_map`](qiskit.providers.BackendV2#coupling_map "qiskit.providers.BackendV2.coupling_map"). So depending on your use case it might be necessary to look deeper than just the equivalent access with [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2"). Below is a table of example access patterns in [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.BackendV1") and the new form with [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2"): diff --git a/docs/api/qiskit/0.41/providers_basicaer.md b/docs/api/qiskit/0.41/providers_basicaer.md index 35e91dc4737..264ac65e90e 100644 --- a/docs/api/qiskit/0.41/providers_basicaer.md +++ b/docs/api/qiskit/0.41/providers_basicaer.md @@ -14,7 +14,7 @@ python_api_name: qiskit.providers.basicaer -`qiskit.providers.basicaer¶` +`qiskit.providers.basicaer` A module of Python-based quantum simulators. Simulators are accessed via the BasicAer provider, e.g.: @@ -26,10 +26,6 @@ backend = BasicAer.get_backend('qasm_simulator') ## Simulators - - -`¶` - | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | | [`QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.QasmSimulatorPy")(\[configuration, provider]) | Python implementation of a qasm simulator. | @@ -38,30 +34,18 @@ backend = BasicAer.get_backend('qasm_simulator') ## Provider - - -`¶` - | | | | --------------------------------------------------------------------------------------------------------------- | -------------------------------- | | [`BasicAerProvider`](qiskit.providers.basicaer.BasicAerProvider "qiskit.providers.basicaer.BasicAerProvider")() | Provider for Basic Aer backends. | ## Job Class - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------ | ------------------ | | [`BasicAerJob`](qiskit.providers.basicaer.BasicAerJob "qiskit.providers.basicaer.BasicAerJob")(backend, job\_id, result) | BasicAerJob class. | ## Exceptions - - -`¶` - | | | | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | | [`BasicAerError`](qiskit.providers.basicaer.BasicAerError "qiskit.providers.basicaer.BasicAerError")(\*message) | Base class for errors raised by Basic Aer. | diff --git a/docs/api/qiskit/0.41/providers_fake_provider.md b/docs/api/qiskit/0.41/providers_fake_provider.md index 7f5f08e4e23..c334ef2013e 100644 --- a/docs/api/qiskit/0.41/providers_fake_provider.md +++ b/docs/api/qiskit/0.41/providers_fake_provider.md @@ -14,22 +14,14 @@ python_api_name: qiskit.providers.fake_provider -`qiskit.providers.fake_provider¶` +`qiskit.providers.fake_provider` ## Overview - - -`¶` - The fake provider module contains fake providers and fake backends classes. The fake backends are built to mimic the behaviors of IBM Quantum systems using system snapshots. The system snapshots contain important information about the quantum system such as coupling map, basis gates, qubit properties (T1, T2, error rate, etc.) which are useful for testing the transpiler and performing noisy simulation of the system. ## Example Usage - - -`¶` - Here is an example of using a fake backend for transpilation and simulation. ```python @@ -90,10 +82,6 @@ Fig. 20 ([`png`](_downloads/1f733fb2488ea6ca71c8e11c0445c973/providers_fake_prov ## Fake Providers - - -`¶` - Fake providers provide access to a list of fake backends. | | | @@ -103,11 +91,7 @@ Fake providers provide access to a list of fake backends. ## Fake Backends - - -`¶` - -### Fake V2 Backends[¶](#fake-v2-backends "Permalink to this headline") +### Fake V2 Backends Fake V2 backends are fake backends with IBM Quantum systems snapshots implemented with [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") interface. @@ -160,7 +144,7 @@ Fake V2 backends are fake backends with IBM Quantum systems snapshots implemente | [`FakeWashingtonV2`](qiskit.providers.fake_provider.FakeWashingtonV2 "qiskit.providers.fake_provider.FakeWashingtonV2")() | A fake 127 qubit backend. | | [`FakeYorktownV2`](qiskit.providers.fake_provider.FakeYorktownV2 "qiskit.providers.fake_provider.FakeYorktownV2")() | A fake 5 qubit backend. | -### Fake V1 Backends[¶](#fake-v1-backends "Permalink to this headline") +### Fake V1 Backends Fake V1 backends are fake backends with IBM Quantum systems snapshots implemented with [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") interface. @@ -212,10 +196,6 @@ Fake V1 backends are fake backends with IBM Quantum systems snapshots implemente ## Special Fake Backends - - -`¶` - Special fake backends are fake backends that were created for special testing purposes. | | | diff --git a/docs/api/qiskit/0.41/providers_models.md b/docs/api/qiskit/0.41/providers_models.md index f8c7537feb9..cfd27c84c38 100644 --- a/docs/api/qiskit/0.41/providers_models.md +++ b/docs/api/qiskit/0.41/providers_models.md @@ -14,16 +14,12 @@ python_api_name: qiskit.providers.models -`qiskit.providers.models¶` +`qiskit.providers.models` Qiskit schema-conformant objects used by the backends and providers. ## Backend Objects - - -`¶` - | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | | [`BackendConfiguration`](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")(backend\_name, ...\[, ...]) | Backwards compat shim representing an abstract backend configuration. | diff --git a/docs/api/qiskit/0.41/pulse.md b/docs/api/qiskit/0.41/pulse.md index 1cc9c0bcd0a..1d5821e036d 100644 --- a/docs/api/qiskit/0.41/pulse.md +++ b/docs/api/qiskit/0.41/pulse.md @@ -14,7 +14,7 @@ python_api_name: qiskit.pulse -`qiskit.pulse¶` +`qiskit.pulse` Qiskit-Pulse is a pulse-level quantum programming kit. This lower level of programming offers the user more control than programming with [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")s. @@ -32,7 +32,7 @@ This is sufficient to allow the quantum physicist to explore and correct for noi -`qiskit.pulse.instructions¶` +`qiskit.pulse.instructions` The `instructions` module holds the various [`Instruction`](#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.Instruction")s which are supported by Qiskit Pulse. Instructions have operands, which typically include at least one [`Channel`](#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") specifying where the instruction will be applied. @@ -69,7 +69,7 @@ These are all instances of the same base class: -`Instruction(operands, name=None)` +`Instruction(operands, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/instruction.py "view source code") The smallest schedulable unit: a single instruction. It has a fixed duration and specified channels. @@ -86,7 +86,7 @@ Instruction initializer. -`qiskit.pulse.library¶` +`qiskit.pulse.library` This library provides Pulse users with convenient methods to build Pulse waveforms. @@ -100,7 +100,7 @@ In contrast, the [`SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pu -### Pulse Models[¶](#pulse-models "Permalink to this headline") +### Pulse Models | | | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | @@ -111,27 +111,27 @@ In contrast, the [`SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pu -### Waveform Pulse Representation[¶](#waveform-pulse-representation "Permalink to this headline") - -| | | -| ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`constant`](qiskit.pulse.library.constant "qiskit.pulse.library.constant")(duration, amp\[, name]) | Generates constant-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | -| [`zero`](qiskit.pulse.library.zero "qiskit.pulse.library.zero")(duration\[, name]) | Generates zero-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | -| [`square`](qiskit.pulse.library.square "qiskit.pulse.library.square")(duration, amp\[, freq, phase, name]) | Generates square wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | -| [`sawtooth`](qiskit.pulse.library.sawtooth "qiskit.pulse.library.sawtooth")(duration, amp\[, freq, phase, name]) | Generates sawtooth wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | -| [`triangle`](qiskit.pulse.library.triangle "qiskit.pulse.library.triangle")(duration, amp\[, freq, phase, name]) | Generates triangle wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | -| [`cos`](qiskit.pulse.library.cos "qiskit.pulse.library.cos")(duration, amp\[, freq, phase, name]) | Generates cosine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | -| [`sin`](qiskit.pulse.library.sin "qiskit.pulse.library.sin")(duration, amp\[, freq, phase, name]) | Generates sine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | -| [`gaussian`](qiskit.pulse.library.gaussian "qiskit.pulse.library.gaussian")(duration, amp, sigma\[, name, zero\_ends]) | Generates unnormalized gaussian [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | -| [`gaussian_deriv`](qiskit.pulse.library.gaussian_deriv "qiskit.pulse.library.gaussian_deriv")(duration, amp, sigma\[, name]) | Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | -| [`sech`](qiskit.pulse.library.sech "qiskit.pulse.library.sech")(duration, amp, sigma\[, name, zero\_ends]) | Generates unnormalized sech [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | -| [`sech_deriv`](qiskit.pulse.library.sech_deriv "qiskit.pulse.library.sech_deriv")(duration, amp, sigma\[, name]) | Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | -| [`gaussian_square`](qiskit.pulse.library.gaussian_square "qiskit.pulse.library.gaussian_square")(duration, amp, sigma\[, ...]) | Generates gaussian square [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | -| [`drag`](qiskit.pulse.library.drag "qiskit.pulse.library.drag")(duration, amp, sigma, beta\[, name, ...]) | Generates Y-only correction DRAG [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform") for standard nonlinear oscillator (SNO) \[1]. | +### Waveform Pulse Representation + +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`constant`](qiskit.pulse.library.constant#qiskit.pulse.library.constant "qiskit.pulse.library.constant")(duration, amp\[, name]) | Generates constant-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | +| [`zero`](qiskit.pulse.library.zero "qiskit.pulse.library.zero")(duration\[, name]) | Generates zero-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | +| [`square`](qiskit.pulse.library.square "qiskit.pulse.library.square")(duration, amp\[, freq, phase, name]) | Generates square wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | +| [`sawtooth`](qiskit.pulse.library.sawtooth "qiskit.pulse.library.sawtooth")(duration, amp\[, freq, phase, name]) | Generates sawtooth wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | +| [`triangle`](qiskit.pulse.library.triangle "qiskit.pulse.library.triangle")(duration, amp\[, freq, phase, name]) | Generates triangle wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | +| [`cos`](qiskit.pulse.library.cos "qiskit.pulse.library.cos")(duration, amp\[, freq, phase, name]) | Generates cosine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | +| [`sin`](qiskit.pulse.library.sin "qiskit.pulse.library.sin")(duration, amp\[, freq, phase, name]) | Generates sine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | +| [`gaussian`](qiskit.pulse.library.gaussian#qiskit.pulse.library.gaussian "qiskit.pulse.library.gaussian")(duration, amp, sigma\[, name, zero\_ends]) | Generates unnormalized gaussian [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | +| [`gaussian_deriv`](qiskit.pulse.library.gaussian_deriv "qiskit.pulse.library.gaussian_deriv")(duration, amp, sigma\[, name]) | Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | +| [`sech`](qiskit.pulse.library.sech "qiskit.pulse.library.sech")(duration, amp, sigma\[, name, zero\_ends]) | Generates unnormalized sech [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | +| [`sech_deriv`](qiskit.pulse.library.sech_deriv "qiskit.pulse.library.sech_deriv")(duration, amp, sigma\[, name]) | Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | +| [`gaussian_square`](qiskit.pulse.library.gaussian_square "qiskit.pulse.library.gaussian_square")(duration, amp, sigma\[, ...]) | Generates gaussian square [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). | +| [`drag`](qiskit.pulse.library.drag#qiskit.pulse.library.drag "qiskit.pulse.library.drag")(duration, amp, sigma, beta\[, name, ...]) | Generates Y-only correction DRAG [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform") for standard nonlinear oscillator (SNO) \[1]. | -### Parametric Pulse Representation[¶](#parametric-pulse-representation "Permalink to this headline") +### Parametric Pulse Representation | | | | ------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -149,7 +149,7 @@ In contrast, the [`SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pu -`qiskit.pulse.channels¶` +`qiskit.pulse.channels` Pulse is meant to be agnostic to the underlying hardware implementation, while still allowing low-level control. Therefore, our signal channels are *virtual* hardware channels. The backend which executes our programs is responsible for mapping these virtual channels to the proper physical channel within the quantum control hardware. @@ -175,7 +175,7 @@ All channels are children of the same abstract base class: -`Channel(index)` +`Channel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Base class of channels. Channels provide a Qiskit-side label for typical quantum control hardware signal channels. The final label -> physical channel mapping is the responsibility of the hardware backend. For instance, `DriveChannel(0)` holds instructions which the backend should map to the signal line driving gate operations on the qubit labeled (indexed) 0. @@ -193,10 +193,6 @@ Channel class. ## Schedules - - -`¶` - Schedules are Pulse programs. They describe instruction sequences for the control hardware. The Schedule is one of the most fundamental objects to this pulse-level programming module. A `Schedule` is a representation of a *program* in Pulse. Each schedule tracks the time of each instruction occuring in parallel over multiple signal *channels*. | | | @@ -210,13 +206,13 @@ Schedules are Pulse programs. They describe instruction sequences for the contro -`qiskit.pulse.transforms¶` +`qiskit.pulse.transforms` The pulse transforms provide transformation routines to reallocate and optimize pulse programs for backends. -### Alignments[¶](#alignments "Permalink to this headline") +### Alignments The alignment transforms define alignment policies of instructions in [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock"). These transformations are called to create [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule")s from [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock")s. @@ -232,7 +228,7 @@ These are all subtypes of the abstract base class [`AlignmentKind`](#qiskit.puls -`AlignmentKind(context_params)` +`AlignmentKind(context_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") An abstract class for schedule alignment. @@ -240,7 +236,7 @@ Create new context. -### Canonicalization[¶](#canonicalization "Permalink to this headline") +### Canonicalization The canonicalization transforms convert schedules to a form amenable for execution on OpenPulse backends. @@ -258,7 +254,7 @@ The canonicalization transforms convert schedules to a form amenable for executi -### DAG[¶](#dag "Permalink to this headline") +### DAG The DAG transforms create DAG representation of input program. This can be used for optimization of instructions and equality checks. @@ -268,7 +264,7 @@ The DAG transforms create DAG representation of input program. This can be used -### Composite transform[¶](#composite-transform "Permalink to this headline") +### Composite transform A sequence of transformations to generate a target code. @@ -282,10 +278,6 @@ A sequence of transformations to generate a target code. ## Pulse Builder - - -`¶` - Use the pulse builder DSL to write pulse programs with an imperative syntax. @@ -476,7 +468,7 @@ The above is just a small taste of what is possible with the builder. See the re | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | | [`build`](qiskit.pulse.builder.build "qiskit.pulse.builder.build")(\[backend, schedule, name, ...]) | Create a context manager for launching the imperative pulse builder DSL. | -### Channels[¶](#channels "Permalink to this headline") +### Channels Methods to return the correct channels for the respective qubit indices. @@ -502,7 +494,7 @@ DriveChannel(0) | [`drive_channel`](qiskit.pulse.builder.drive_channel "qiskit.pulse.builder.drive_channel")(qubit) | Return `DriveChannel` for `qubit` on the active builder backend. | | [`measure_channel`](qiskit.pulse.builder.measure_channel "qiskit.pulse.builder.measure_channel")(qubit) | Return `MeasureChannel` for `qubit` on the active builder backend. | -### Instructions[¶](#instructions "Permalink to this headline") +### Instructions Pulse instructions are available within the builder interface. Here’s an example: @@ -549,7 +541,7 @@ drive_sched.draw() | [`shift_phase`](qiskit.pulse.builder.shift_phase "qiskit.pulse.builder.shift_phase")(phase, channel\[, name]) | Shift the `phase` of a pulse `channel`. | | [`snapshot`](qiskit.pulse.builder.snapshot "qiskit.pulse.builder.snapshot")(label\[, snapshot\_type]) | Simulator snapshot. | -### Contexts[¶](#contexts "Permalink to this headline") +### Contexts Builder aware contexts that modify the construction of a pulse program. For example an alignment context like [`align_right()`](qiskit.pulse.builder.align_right "qiskit.pulse.builder.align_right") may be used to align all pulses as late as possible in a pulse program. @@ -583,7 +575,7 @@ pulse_prog.draw() | [`phase_offset`](qiskit.pulse.builder.phase_offset "qiskit.pulse.builder.phase_offset")(phase, \*channels) | Shift the phase of input channels on entry into context and undo on exit. | | [`transpiler_settings`](qiskit.pulse.builder.transpiler_settings "qiskit.pulse.builder.transpiler_settings")(\*\*settings) | Set the currently active transpiler settings for this context. | -### Macros[¶](#macros "Permalink to this headline") +### Macros Macros help you add more complex functionality to your pulse program. @@ -608,7 +600,7 @@ MemorySlot(0) | [`measure_all`](qiskit.pulse.builder.measure_all "qiskit.pulse.builder.measure_all")() | Measure all qubits within the currently active builder context. | | [`delay_qubits`](qiskit.pulse.builder.delay_qubits "qiskit.pulse.builder.delay_qubits")(duration, \*qubits) | Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. | -### Circuit Gates[¶](#circuit-gates "Permalink to this headline") +### Circuit Gates To use circuit level gates within your pulse program call a circuit with [`call()`](qiskit.pulse.builder.call "qiskit.pulse.builder.call"). @@ -636,7 +628,7 @@ with pulse.build(backend) as u3_sched: | [`u3`](qiskit.pulse.builder.u3 "qiskit.pulse.builder.u3")(theta, phi, lam, qubit) | Call a `U3Gate` on the input physical qubit. | | [`x`](qiskit.pulse.builder.x "qiskit.pulse.builder.x")(qubit) | Call a `XGate` on the input physical qubit. | -### Utilities[¶](#utilities "Permalink to this headline") +### Utilities The utility functions can be used to gather attributes about the backend and modify how the program is built. @@ -677,23 +669,15 @@ There are 1e-06 seconds in 4500 samples. ## Configuration - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`InstructionScheduleMap`](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap")() | Mapping from [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") [`qiskit.circuit.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") names and qubits to [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") s. In particular, the mapping is formatted as type::. | ## Exceptions - - -`¶` - -`PulseError(*message)` +`PulseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/exceptions.py "view source code") Errors raised by the pulse module. diff --git a/docs/api/qiskit/0.41/qasm.md b/docs/api/qiskit/0.41/qasm.md index 20f1c1c052d..e7c5e864bd4 100644 --- a/docs/api/qiskit/0.41/qasm.md +++ b/docs/api/qiskit/0.41/qasm.md @@ -14,14 +14,10 @@ python_api_name: qiskit.qasm -`qiskit.qasm¶` +`qiskit.qasm` ## QASM Routines - - -`¶` - | | | | ------------------------------------------------------------------- | ---------------------------------------------------- | | [`Qasm`](qiskit.qasm.Qasm "qiskit.qasm.Qasm")(\[filename, data]) | OPENQASM circuit object. | @@ -29,10 +25,6 @@ python_api_name: qiskit.qasm ## Pygments - - -`¶` - | | | | ------------------------------------------------------------------------------------------ | -------------------------------------------- | | [`OpenQASMLexer`](qiskit.qasm.OpenQASMLexer "qiskit.qasm.OpenQASMLexer")(\*args, \*\*kwds) | A pygments lexer for OpenQasm. | diff --git a/docs/api/qiskit/0.41/qasm3.md b/docs/api/qiskit/0.41/qasm3.md index c3695001a16..df45a7c3ade 100644 --- a/docs/api/qiskit/0.41/qasm3.md +++ b/docs/api/qiskit/0.41/qasm3.md @@ -14,21 +14,17 @@ python_api_name: qiskit.qasm3 -`qiskit.qasm3¶` +`qiskit.qasm3` Qiskit provides some tools for converting between [OpenQASM 3](https://openqasm.com) representations of quantum programs, and the [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") class. These will continue to evolve as Qiskit’s support for the dynamic-circuit capabilities expressed by OpenQASM 3 increases. ## Exporting to OpenQASM 3 - - -`¶` - The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3.dump") and [`dumps()`](#qiskit.qasm3.dumps "qiskit.qasm3.dumps"), which respectively export to a file (given as a filename) and to a Python string. -`dump(circuit, stream, **kwargs)` +`dump(circuit, stream, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as a OpenQASM3 stream to file-like object. @@ -44,7 +40,7 @@ Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.Qua -`dumps(circuit, **kwargs)` +`dumps(circuit, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM3 string. @@ -65,7 +61,7 @@ Both of these exporter functions are single-use wrappers around the main [`Expor -`Exporter(includes=('stdgates.inc',), basis_gates=('U',), disable_constants=False, alias_classical_registers=False, indent='  ')` +`Exporter(includes=('stdgates.inc',), basis_gates=('U',), disable_constants=False, alias_classical_registers=False, indent='  ')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exporter.py "view source code") QASM3 exporter main class. @@ -97,7 +93,7 @@ All of these interfaces will raise [`QASM3ExporterError`](#qiskit.qasm3.QASM3Exp -`QASM3ExporterError(*message)` +`QASM3ExporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exceptions.py "view source code") An error raised during running the OpenQASM 3 exporter. @@ -105,10 +101,6 @@ Set the error message. ## Importing from OpenQASM 3 - - -`¶` - Currently only two high-level functions are offered, as Qiskit support for importing from OpenQASM 3 is in its infancy, and the implementation is expected to change significantly. The two functions are [`load()`](#qiskit.qasm3.load "qiskit.qasm3.load") and [`loads()`](#qiskit.qasm3.loads "qiskit.qasm3.loads"), which are direct counterparts of [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3.dump") and [`dumps()`](#qiskit.qasm3.dumps "qiskit.qasm3.dumps"), respectively loading a program indirectly from a named file and directly from a given string. @@ -123,7 +115,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor -`load(filename)` +`load(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the file `filename`. @@ -145,7 +137,7 @@ a circuit representation of the OpenQASM 3 program. -`loads(program)` +`loads(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/__init__.py "view source code") Load an OpenQASM 3 program from the given string. @@ -169,7 +161,7 @@ Both of these two functions raise [`QASM3ImporterError`](#qiskit.qasm3.QASM3Impo -`QASM3ImporterError(*message)` +`QASM3ImporterError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm3/exceptions.py "view source code") An error raised during the OpenQASM 3 importer. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmError.md index 9f5fbecfe51..78d413acdf9 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmError.md @@ -6,11 +6,11 @@ python_api_type: exception python_api_name: qiskit.algorithms.AlgorithmError --- -# qiskit.algorithms.AlgorithmError[¶](#qiskit-algorithms-algorithmerror "Permalink to this headline") +# qiskit.algorithms.AlgorithmError -`AlgorithmError(*message)` +`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmJob.md b/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmJob.md index 4be7fd7227b..877b84bd5c5 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmJob.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AlgorithmJob.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.AlgorithmJob --- -# AlgorithmJob[¶](#algorithmjob "Permalink to this headline") +# AlgorithmJob -`AlgorithmJob(function, *args, **kwargs)` +`AlgorithmJob(function, *args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/algorithm_job.py "view source code") Bases: `qiskit.primitives.primitive_job.PrimitiveJob` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.41/qiskit.algorithms.AmplificationProblem.md index 9e0651e7216..c93e4539d10 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AmplificationProblem.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.AmplificationProblem --- -# AmplificationProblem[¶](#amplificationproblem "Permalink to this headline") +# AmplificationProblem -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeAmplifier.md b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeAmplifier.md index 99a6b3b60ef..650136dfd86 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeAmplifier.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeAmplifier.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.AmplitudeAmplifier --- -# AmplitudeAmplifier[¶](#amplitudeamplifier "Permalink to this headline") +# AmplitudeAmplifier -`AmplitudeAmplifier` +`AmplitudeAmplifier`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The interface for amplification algorithms. -`abstract AmplitudeAmplifier.amplify(amplification_problem)` +`abstract AmplitudeAmplifier.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/amplitude_amplifier.py "view source code") Run the amplification algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimation.md index 8733f3c8f17..0c2135dc58e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.AmplitudeEstimation --- -# AmplitudeEstimation[¶](#amplitudeestimation "Permalink to this headline") +# AmplitudeEstimation -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)` +`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -54,7 +54,7 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs -`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')` +`static AmplitudeEstimation.compute_confidence_interval(result, alpha=0.05, kind='likelihood_ratio')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the (1 - alpha) confidence interval. @@ -77,7 +77,7 @@ The (1 - alpha) confidence interval of the specified kind. -`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)` +`static AmplitudeEstimation.compute_mle(result, apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Compute the Maximum Likelihood Estimator (MLE). @@ -98,7 +98,7 @@ The MLE for the provided result object. -`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)` +`AmplitudeEstimation.construct_circuit(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Construct the Amplitude Estimation quantum circuit. @@ -119,7 +119,7 @@ The QuantumCircuit object for the constructed circuit. -`AmplitudeEstimation.estimate(estimation_problem)` +`AmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. @@ -145,7 +145,7 @@ An amplitude estimation results object. -`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)` +`AmplitudeEstimation.evaluate_measurements(circuit_results, threshold=1e-06)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Evaluate the results from the circuit simulation. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimationResult.md index 338dbfa1a94..89ca764cc51 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimationResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.AmplitudeEstimationResult --- -# AmplitudeEstimationResult[¶](#amplitudeestimationresult "Permalink to this headline") +# AmplitudeEstimationResult -`AmplitudeEstimationResult` +`AmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/ae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimator.md index b67c125b943..763f10c1313 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimator.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.AmplitudeEstimator --- -# AmplitudeEstimator[¶](#amplitudeestimator "Permalink to this headline") +# AmplitudeEstimator -`AmplitudeEstimator` +`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The Amplitude Estimation interface. -`abstract AmplitudeEstimator.estimate(estimation_problem)` +`abstract AmplitudeEstimator.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Run the amplitude estimation algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimatorResult.md index aa553f71cfc..3ba8931a981 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.AmplitudeEstimatorResult --- -# AmplitudeEstimatorResult[¶](#amplitudeestimatorresult "Permalink to this headline") +# AmplitudeEstimatorResult -`AmplitudeEstimatorResult` +`AmplitudeEstimatorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.Eigensolver.md index aa5b323e22c..9f532a0eb3e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.Eigensolver.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.Eigensolver --- -# Eigensolver[¶](#eigensolver "Permalink to this headline") +# Eigensolver -`Eigensolver` +`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ EigensolverResult -`classmethod Eigensolver.supports_aux_operators()` +`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.EigensolverResult.md index 0b213f09080..3b79806ee73 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.EigensolverResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.EigensolverResult --- -# EigensolverResult[¶](#eigensolverresult "Permalink to this headline") +# EigensolverResult -`EigensolverResult` +`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.41/qiskit.algorithms.EstimationProblem.md index 1542331679f..15f2762b928 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.EstimationProblem.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.EstimationProblem --- -# EstimationProblem[¶](#estimationproblem "Permalink to this headline") +# EstimationProblem -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This class contains all problem-specific information required to run an amplitud -`EstimationProblem.rescale(scaling_factor)` +`EstimationProblem.rescale(scaling_factor)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Rescale the good state amplitude in the estimation problem. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionProblem.md b/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionProblem.md index 43fc60fb198..afa2803134e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionProblem.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionProblem.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.EvolutionProblem --- -# EvolutionProblem[¶](#evolutionproblem "Permalink to this headline") +# EvolutionProblem -`EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)` +`EvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Bases: `object` @@ -40,7 +40,7 @@ This class is the input to time evolution algorithms and must contain informatio -`EvolutionProblem.validate_params()` +`EvolutionProblem.validate_params()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_problem.py "view source code") Checks if all parameters present in the Hamiltonian are also present in the dictionary that maps them to values. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionResult.md index 4257afd2392..44ee65ffc1b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.EvolutionResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.EvolutionResult --- -# EvolutionResult[¶](#evolutionresult "Permalink to this headline") +# EvolutionResult -`EvolutionResult(evolved_state, aux_ops_evaluated=None)` +`EvolutionResult(evolved_state, aux_ops_evaluated=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/evolution_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimation.md index 469af9df303..c612f92be81 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.FasterAmplitudeEstimation --- -# FasterAmplitudeEstimation[¶](#fasteramplitudeestimation "Permalink to this headline") +# FasterAmplitudeEstimation -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)` +`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -52,7 +52,7 @@ Due to the iterative version of the QPE, this algorithm does not require any add -`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)` +`FasterAmplitudeEstimation.construct_circuit(estimation_problem, k, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Construct the circuit $Q^k X |0\rangle>$. @@ -72,7 +72,7 @@ The circuit $Q^k X |0\rangle$. -`FasterAmplitudeEstimation.estimate(estimation_problem)` +`FasterAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimationResult.md index 7f4b706a77f..a24a7e8db42 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult --- -# FasterAmplitudeEstimationResult[¶](#fasteramplitudeestimationresult "Permalink to this headline") +# FasterAmplitudeEstimationResult -`FasterAmplitudeEstimationResult` +`FasterAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/fae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.41/qiskit.algorithms.Grover.md index 6001d87820c..1602cb3525b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.Grover.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.Grover --- -# Grover[¶](#grover "Permalink to this headline") +# Grover -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)` +`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: [`qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier`](qiskit.algorithms.AmplitudeAmplifier "qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifier") @@ -94,7 +94,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`Grover.amplify(amplification_problem)` +`Grover.amplify(amplification_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Run the Grover algorithm. @@ -121,7 +121,7 @@ The result as a `GroverResult`, where e.g. the most likely state can be queried -`Grover.construct_circuit(problem, power=None, measurement=False)` +`Grover.construct_circuit(problem, power=None, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Construct the circuit for Grover’s algorithm with `power` Grover operators. @@ -147,7 +147,7 @@ the QuantumCircuit object for the constructed circuit -`static Grover.optimal_num_iterations(num_solutions, num_qubits)` +`static Grover.optimal_num_iterations(num_solutions, num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Return the optimal number of iterations, if the number of solutions is known. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.GroverResult.md index 78fc2b86748..1548fe84ce2 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.GroverResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.GroverResult --- -# GroverResult[¶](#groverresult "Permalink to this headline") +# GroverResult -`GroverResult` +`GroverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_amplifiers/grover.py "view source code") Bases: `qiskit.algorithms.amplitude_amplifiers.amplitude_amplifier.AmplitudeAmplifierResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimation.md index fa36cac60c4..cc4125d774e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation --- -# HamiltonianPhaseEstimation[¶](#hamiltonianphaseestimation "Permalink to this headline") +# HamiltonianPhaseEstimation -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` +`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Bases: `object` @@ -58,7 +58,7 @@ T.E. O’Brien, B. Tarasinski, B.M. Terhal [arXiv:1809.09697](https://arxiv.org/ -`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)` +`HamiltonianPhaseEstimation.estimate(hamiltonian, state_preparation=None, evolution=None, bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation.py "view source code") Run the Hamiltonian phase estimation algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index e35347c2a20..e93c2502e25 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult --- -# HamiltonianPhaseEstimationResult[¶](#hamiltonianphaseestimationresult "Permalink to this headline") +# HamiltonianPhaseEstimationResult -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)` +`HamiltonianPhaseEstimationResult.filter_phases(cutoff=0.0, scaled=True, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Filter phases as does PhaseEstimatorResult.filter\_phases, with the addition that phi is shifted and translated to return eigenvalues of the Hamiltonian. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryEvolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryEvolver.md index 1a364b25e3a..4e0f4a06b45 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryEvolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryEvolver.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.ImaginaryEvolver --- -# ImaginaryEvolver[¶](#imaginaryevolver "Permalink to this headline") +# ImaginaryEvolver -`ImaginaryEvolver` +`ImaginaryEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ The ImaginaryEvolver interface has been superseded by the `qiskit.algorithms.tim -`abstract ImaginaryEvolver.evolve(evolution_problem)` +`abstract ImaginaryEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/imaginary_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryTimeEvolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryTimeEvolver.md index 646e301bd6e..b86e703ec7f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryTimeEvolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.ImaginaryTimeEvolver.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.ImaginaryTimeEvolver --- -# ImaginaryTimeEvolver[¶](#imaginarytimeevolver "Permalink to this headline") +# ImaginaryTimeEvolver -`ImaginaryTimeEvolver` +`ImaginaryTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for Quantum Imaginary Time Evolution. -`abstract ImaginaryTimeEvolver.evolve(evolution_problem)` +`abstract ImaginaryTimeEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/imaginary_time_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimation.md index e204a7a38f2..0d80a7f442e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation --- -# IterativeAmplitudeEstimation[¶](#iterativeamplitudeestimation "Permalink to this headline") +# IterativeAmplitudeEstimation -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)` +`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -54,7 +54,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea -`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)` +`IterativeAmplitudeEstimation.construct_circuit(estimation_problem, k=0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Construct the circuit $\mathcal{Q}^k \mathcal{A} |0\rangle$. @@ -78,7 +78,7 @@ The circuit implementing $\mathcal{Q}^k \mathcal{A} |0\rangle$. -`IterativeAmplitudeEstimation.estimate(estimation_problem)` +`IterativeAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index bc51290abea..527767991ec 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult --- -# IterativeAmplitudeEstimationResult[¶](#iterativeamplitudeestimationresult "Permalink to this headline") +# IterativeAmplitudeEstimationResult -`IterativeAmplitudeEstimationResult` +`IterativeAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/iae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.41/qiskit.algorithms.IterativePhaseEstimation.md index 6054c4780f6..69e3582f8db 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.IterativePhaseEstimation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.IterativePhaseEstimation --- -# IterativePhaseEstimation[¶](#iterativephaseestimation "Permalink to this headline") +# IterativePhaseEstimation -`IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)` +`IterativePhaseEstimation(num_iterations, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -39,7 +39,7 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 -`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0.0, measurement=False)` +`IterativePhaseEstimation.construct_circuit(unitary, state_preparation, k, omega=0.0, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") Construct the kth iteration Quantum Phase Estimation circuit. @@ -65,7 +65,7 @@ the quantum circuit per iteration -`IterativePhaseEstimation.estimate(unitary, state_preparation)` +`IterativePhaseEstimation.estimate(unitary, state_preparation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/ipe.py "view source code") Estimate the eigenphase of the input unitary and initial-state pair. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index 2eee46e2ca4..8e579d1c641 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation --- -# MaximumLikelihoodAmplitudeEstimation[¶](#maximumlikelihoodamplitudeestimation "Permalink to this headline") +# MaximumLikelihoodAmplitudeEstimation -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)` +`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimator") @@ -45,7 +45,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// -`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)` +`static MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval(result, alpha, kind='fisher', apply_post_processing=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the alpha confidence interval using the method kind. @@ -71,7 +71,7 @@ The specified confidence interval. -`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)` +`MaximumLikelihoodAmplitudeEstimation.compute_mle(circuit_results, estimation_problem, num_state_qubits=None, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Compute the MLE via a grid-search. @@ -92,7 +92,7 @@ The MLE for the provided result object. -`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)` +`MaximumLikelihoodAmplitudeEstimation.construct_circuits(estimation_problem, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Construct the Amplitude Estimation w/o QPE quantum circuits. @@ -109,7 +109,7 @@ A list with the QuantumCircuit objects for the algorithm. -`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)` +`MaximumLikelihoodAmplitudeEstimation.estimate(estimation_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Run the amplitude estimation algorithm on provided estimation problem. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 5d37c2f873f..2d71e1a6ca5 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult --- -# MaximumLikelihoodAmplitudeEstimationResult[¶](#maximumlikelihoodamplitudeestimationresult "Permalink to this headline") +# MaximumLikelihoodAmplitudeEstimationResult -`MaximumLikelihoodAmplitudeEstimationResult` +`MaximumLikelihoodAmplitudeEstimationResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/amplitude_estimators/mlae.py "view source code") Bases: [`qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.amplitude_estimators.amplitude_estimator.AmplitudeEstimatorResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolver.md index 073f2b83005..0020b51c82f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolver.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.MinimumEigensolver --- -# MinimumEigensolver[¶](#minimumeigensolver "Permalink to this headline") +# MinimumEigensolver -`MinimumEigensolver` +`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `abc.ABC` @@ -26,7 +26,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -47,7 +47,7 @@ MinimumEigensolverResult -`classmethod MinimumEigensolver.supports_aux_operators()` +`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolverResult.md index 86dec81706d..15dd2cf53ec 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.MinimumEigensolverResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.MinimumEigensolverResult --- -# MinimumEigensolverResult[¶](#minimumeigensolverresult "Permalink to this headline") +# MinimumEigensolverResult -`MinimumEigensolverResult` +`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.NumPyEigensolver.md index 7c80bad4b79..58331e05214 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.NumPyEigensolver.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.NumPyEigensolver --- -# NumPyEigensolver[¶](#numpyeigensolver "Permalink to this headline") +# NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)` +`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Bases: [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") @@ -35,7 +35,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -56,7 +56,7 @@ EigensolverResult -`classmethod NumPyEigensolver.supports_aux_operators()` +`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/numpy_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.NumPyMinimumEigensolver.md index 0217c7d0a84..b78d86e7509 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.NumPyMinimumEigensolver --- -# NumPyMinimumEigensolver[¶](#numpyminimumeigensolver "Permalink to this headline") +# NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)` +`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Bases: [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") @@ -28,7 +28,7 @@ The NumPyMinimumEigensolver class has been superseded by the [`qiskit.algorithms -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -49,7 +49,7 @@ MinimumEigensolverResult -`classmethod NumPyMinimumEigensolver.supports_aux_operators()` +`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/numpy_minimum_eigen_solver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.PVQD.md b/docs/api/qiskit/0.41/qiskit.algorithms.PVQD.md index 087509f9607..07571f4b230 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.PVQD.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.PVQD.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.PVQD --- -# PVQD[¶](#pvqd "Permalink to this headline") +# PVQD -`PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)` +`PVQD(fidelity, ansatz, initial_parameters, estimator=None, optimizer=None, num_timesteps=None, evolution=None, use_parameter_shift=True, initial_guess=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") @@ -158,7 +158,7 @@ quantum algorithm for the time evolution of parameterized circuits, [Quantum 5, -`PVQD.evolve(evolution_problem)` +`PVQD.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. @@ -185,7 +185,7 @@ A result object containing the evolution information and evaluated observables. -`PVQD.get_loss(hamiltonian, ansatz, dt, current_parameters)` +`PVQD.get_loss(hamiltonian, ansatz, dt, current_parameters)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Get a function to evaluate the infidelity between Trotter step and ansatz. @@ -210,7 +210,7 @@ a second callable to evaluate the gradient of the infidelity. -`PVQD.step(hamiltonian, ansatz, theta, dt, initial_guess)` +`PVQD.step(hamiltonian, ansatz, theta, dt, initial_guess)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd.py "view source code") Perform a single time step. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.PVQDResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.PVQDResult.md index bf7c2fb490b..56eee3c3568 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.PVQDResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.PVQDResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.PVQDResult --- -# PVQDResult[¶](#pvqdresult "Permalink to this headline") +# PVQDResult -`PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)` +`PVQDResult(evolved_state, aux_ops_evaluated=None, times=None, parameters=None, fidelities=None, estimated_error=None, observables=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/pvqd/pvqd_result.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult`](qiskit.algorithms.TimeEvolutionResult "qiskit.algorithms.time_evolvers.time_evolution_result.TimeEvolutionResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimation.md index 4468be4499f..097d4191465 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.PhaseEstimation --- -# PhaseEstimation[¶](#phaseestimation "Permalink to this headline") +# PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)` +`PhaseEstimation(num_evaluation_qubits, quantum_instance=None, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimator` @@ -66,7 +66,7 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) -`PhaseEstimation.construct_circuit(unitary, state_preparation=None)` +`PhaseEstimation.construct_circuit(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Return the circuit to be executed to estimate phases. @@ -80,7 +80,7 @@ This circuit includes as sub-circuits the core phase estimation circuit, with th -`PhaseEstimation.estimate(unitary, state_preparation=None)` +`PhaseEstimation.estimate(unitary, state_preparation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Build a phase estimation circuit and run the corresponding algorithm. @@ -101,7 +101,7 @@ An instance of qiskit.algorithms.phase\_estimator\_result.PhaseEstimationResult. -`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)` +`PhaseEstimation.estimate_from_pe_circuit(pe_circuit, num_unitary_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation.py "view source code") Run the phase estimation algorithm on a phase estimation circuit diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationResult.md index a7c7d7ccd55..c592522c411 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.PhaseEstimationResult --- -# PhaseEstimationResult[¶](#phaseestimationresult "Permalink to this headline") +# PhaseEstimationResult -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` +`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.phase_estimators.phase_estimator.PhaseEstimatorResult` @@ -48,7 +48,7 @@ Any property from the argument that exists in the receiver is updated. :type res -`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)` +`PhaseEstimationResult.filter_phases(cutoff=0.0, as_float=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_result.py "view source code") Return a filtered dict of phases (keys) and frequencies (values). diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationScale.md index bf810baf31a..64ccc36c8ba 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.PhaseEstimationScale.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.PhaseEstimationScale --- -# PhaseEstimationScale[¶](#phaseestimationscale "Permalink to this headline") +# PhaseEstimationScale -`PhaseEstimationScale(bound)` +`PhaseEstimationScale(bound)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Increasing `bound` decreases the part of the interval $[0, 1)$ that is used to m -`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)` +`classmethod PhaseEstimationScale.from_pauli_sum(pauli_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. @@ -58,7 +58,7 @@ A `PhaseEstimationScale` object -`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)` +`PhaseEstimationScale.scale_phase(phi, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a phase into an eigenvalue. @@ -81,7 +81,7 @@ An eigenvalue computed from the input phase. -`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)` +`PhaseEstimationScale.scale_phases(phases, id_coefficient=0.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/phase_estimators/phase_estimation_scale.py "view source code") Convert a list or dict of phases to eigenvalues. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.41/qiskit.algorithms.QAOA.md index b3cba9c1963..d94ee5a35ee 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.QAOA.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.QAOA --- -# QAOA[¶](#qaoa "Permalink to this headline") +# QAOA -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: [`qiskit.algorithms.minimum_eigen_solvers.vqe.VQE`](qiskit.algorithms.VQE "qiskit.algorithms.minimum_eigen_solvers.vqe.VQE") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.RealEvolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.RealEvolver.md index 1083ae34361..649a122e127 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.RealEvolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.RealEvolver.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.RealEvolver --- -# RealEvolver[¶](#realevolver "Permalink to this headline") +# RealEvolver -`RealEvolver` +`RealEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/real_evolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ The RealEvolver interface has been superseded by the `qiskit.algorithms.time_evo -`abstract RealEvolver.evolve(evolution_problem)` +`abstract RealEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/real_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.RealTimeEvolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.RealTimeEvolver.md index 0a53679de2d..d75806df219 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.RealTimeEvolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.RealTimeEvolver.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.RealTimeEvolver --- -# RealTimeEvolver[¶](#realtimeevolver "Permalink to this headline") +# RealTimeEvolver -`RealTimeEvolver` +`RealTimeEvolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for Quantum Real Time Evolution. -`abstract RealTimeEvolver.evolve(evolution_problem)` +`abstract RealTimeEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/real_time_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.SciPyImaginaryEvolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.SciPyImaginaryEvolver.md index b4b248cbaeb..5aa6b449e68 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.SciPyImaginaryEvolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.SciPyImaginaryEvolver.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.SciPyImaginaryEvolver --- -# SciPyImaginaryEvolver[¶](#scipyimaginaryevolver "Permalink to this headline") +# SciPyImaginaryEvolver -`SciPyImaginaryEvolver(num_timesteps)` +`SciPyImaginaryEvolver(num_timesteps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") @@ -32,7 +32,7 @@ Evolves an initial state $|\Psi\rangle$ for an imaginary time $\tau = it$ under -`SciPyImaginaryEvolver.evolve(evolution_problem)` +`SciPyImaginaryEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_imaginary_evolver.py "view source code") Perform imaginary time evolution $\exp(-\tau H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.SciPyRealEvolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.SciPyRealEvolver.md index 03051368a5f..d68a5b94634 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.SciPyRealEvolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.SciPyRealEvolver.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.SciPyRealEvolver --- -# SciPyRealEvolver[¶](#scipyrealevolver "Permalink to this headline") +# SciPyRealEvolver -`SciPyRealEvolver(num_timesteps)` +`SciPyRealEvolver(num_timesteps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") @@ -32,7 +32,7 @@ Evolves an initial state $|\Psi\rangle$ for a time $t$ under a Hamiltonian $H$, -`SciPyRealEvolver.evolve(evolution_problem)` +`SciPyRealEvolver.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/classical_methods/scipy_real_evolver.py "view source code") Perform real time evolution $\exp(-i t H)|\Psi\rangle$. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.41/qiskit.algorithms.Shor.md index 1a0913b4dc7..8982999aaa8 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.Shor.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.Shor --- -# Shor[¶](#shor "Permalink to this headline") +# Shor -`Shor(quantum_instance=None)` +`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph -`Shor.construct_circuit(N, a=2, measurement=False)` +`Shor.construct_circuit(N, a=2, measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Construct quantum part of the algorithm. @@ -56,7 +56,7 @@ Quantum circuit. -`Shor.factor(N, a=2)` +`Shor.factor(N, a=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Execute the algorithm. @@ -84,7 +84,7 @@ results of the algorithm. -`static Shor.modinv(a, m)` +`static Shor.modinv(a, m)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Returns the modular multiplicative inverse of a with respect to the modulus m. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.ShorResult.md index 61d90aa33d5..88b1cf000ca 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.ShorResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.ShorResult --- -# ShorResult[¶](#shorresult "Permalink to this headline") +# ShorResult -`ShorResult` +`ShorResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionProblem.md b/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionProblem.md index 258fccab024..e8bcb2be6d2 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionProblem.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionProblem.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.TimeEvolutionProblem --- -# TimeEvolutionProblem[¶](#timeevolutionproblem "Permalink to this headline") +# TimeEvolutionProblem -`TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)` +`TimeEvolutionProblem(hamiltonian, time, initial_state=None, aux_operators=None, truncation_threshold=1e-12, t_param=None, param_value_map=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") Bases: `object` @@ -98,7 +98,7 @@ dict\[[Parameter](qiskit.circuit.Parameter "qiskit.circuit.Parameter"), complex] -`TimeEvolutionProblem.validate_params()` +`TimeEvolutionProblem.validate_params()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_problem.py "view source code") Checks if all parameters present in the Hamiltonian are also present in the dictionary that maps them to values. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionResult.md index 715becd771f..d74532b8e54 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.TimeEvolutionResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.TimeEvolutionResult --- -# TimeEvolutionResult[¶](#timeevolutionresult "Permalink to this headline") +# TimeEvolutionResult -`TimeEvolutionResult(evolved_state, aux_ops_evaluated=None, observables=None, times=None)` +`TimeEvolutionResult(evolved_state, aux_ops_evaluated=None, observables=None, times=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/time_evolution_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.TrotterQRTE.md b/docs/api/qiskit/0.41/qiskit.algorithms.TrotterQRTE.md index e1e4207cb60..020d37c6b6b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.TrotterQRTE.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.TrotterQRTE.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.TrotterQRTE --- -# TrotterQRTE[¶](#trotterqrte "Permalink to this headline") +# TrotterQRTE -`TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)` +`TrotterQRTE(product_formula=None, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`qiskit.algorithms.evolvers.real_evolver.RealEvolver`](qiskit.algorithms.RealEvolver "qiskit.algorithms.evolvers.real_evolver.RealEvolver") @@ -51,7 +51,7 @@ evolved_state = trotter_qrte.evolve(evolution_problem).evolved_state -`TrotterQRTE.evolve(evolution_problem)` +`TrotterQRTE.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Evolves a quantum state for a given time using the Trotterization method based on a product formula provided. The result is provided in the form of a quantum circuit. If auxiliary operators are included in the `evolution_problem`, they are evaluated on an evolved state using a backend provided. @@ -80,7 +80,7 @@ Evolution result that includes an evolved state as a quantum circuit and, option -`classmethod TrotterQRTE.supports_aux_operators()` +`classmethod TrotterQRTE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/evolvers/trotterization/trotter_qrte.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.VQD.md b/docs/api/qiskit/0.41/qiskit.algorithms.VQD.md index 65332431b92..2380e565403 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.VQD.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.VQD.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.VQD --- -# VQD[¶](#vqd "Permalink to this headline") +# VQD -`VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` +`VQD(ansatz=None, k=2, betas=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.eigen_solvers.eigen_solver.Eigensolver") @@ -48,7 +48,7 @@ The length of the *initial\_point* list value must match the number of the param -`VQD.compute_eigenvalues(operator, aux_operators=None)` +`VQD.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Computes eigenvalues. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -69,7 +69,7 @@ EigensolverResult -`VQD.construct_circuit(parameter, operator)` +`VQD.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Return the circuits used to compute the expectation value. @@ -90,7 +90,7 @@ A list of the circuits used to compute the expectation value. -`VQD.construct_expectation(parameter, operator, return_expectation=False)` +`VQD.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -117,7 +117,7 @@ The Operator equalling the measurement of the ansatz `StateFn` by the Observable -`VQD.get_energy_evaluation(step, operator, return_expectation=False, prev_states=None)` +`VQD.get_energy_evaluation(step, operator, return_expectation=False, prev_states=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -147,7 +147,7 @@ A callable that computes and returns the energy of the hamiltonian of each param -`VQD.print_settings()` +`VQD.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Preparing the setting of VQD into a string. @@ -163,7 +163,7 @@ str -`classmethod VQD.supports_aux_operators()` +`classmethod VQD.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.VQDResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.VQDResult.md index c698d394962..fb1fd772701 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.VQDResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.VQDResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.VQDResult --- -# VQDResult[¶](#vqdresult "Permalink to this headline") +# VQDResult -`VQDResult` +`VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigen_solvers/vqd.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.eigen_solvers.eigen_solver.EigensolverResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.41/qiskit.algorithms.VQE.md index 1e542927611..dd580044bc0 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.VQE.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.VQE --- -# VQE[¶](#vqe "Permalink to this headline") +# VQE -`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` +`VQE(ansatz=None, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.minimum_eigen_solvers.minimum_eigen_solver.MinimumEigensolver") @@ -76,7 +76,7 @@ optimizer = partial(minimize, method="L-BFGS-B") -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. @@ -97,7 +97,7 @@ MinimumEigensolverResult -`VQE.construct_circuit(parameter, operator)` +`VQE.construct_circuit(parameter, operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Return the circuits used to compute the expectation value. @@ -118,7 +118,7 @@ A list of the circuits used to compute the expectation value. -`VQE.construct_expectation(parameter, operator, return_expectation=False)` +`VQE.construct_expectation(parameter, operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Generate the ansatz circuit and expectation value measurement, and return their runnable composition. @@ -145,7 +145,7 @@ The Operator equalling the measurement of the ansatz `StateFn` by the Observable -`VQE.get_energy_evaluation(operator, return_expectation=False)` +`VQE.get_energy_evaluation(operator, return_expectation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Returns a function handle to evaluates the energy at given parameters for the ansatz. @@ -172,7 +172,7 @@ Energy of the hamiltonian of each parameter, and, optionally, the expectation co -`VQE.print_settings()` +`VQE.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Preparing the setting of VQE into a string. @@ -188,7 +188,7 @@ str -`classmethod VQE.supports_aux_operators()` +`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigen_solvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.VarQITE.md b/docs/api/qiskit/0.41/qiskit.algorithms.VarQITE.md index 9c044231131..16289e5c6f3 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.VarQITE.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.VarQITE.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.VarQITE --- -# VarQITE[¶](#varqite "Permalink to this headline") +# VarQITE -`VarQITE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)` +`VarQITE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/var_qite.py "view source code") Bases: `qiskit.algorithms.time_evolvers.variational.var_qte.VarQTE`, [`qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver`](qiskit.algorithms.ImaginaryTimeEvolver "qiskit.algorithms.time_evolvers.imaginary_time_evolver.ImaginaryTimeEvolver") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.VarQRTE.md b/docs/api/qiskit/0.41/qiskit.algorithms.VarQRTE.md index 1d78fdd6bf1..ea75c10fd8f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.VarQRTE.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.VarQRTE.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.VarQRTE --- -# VarQRTE[¶](#varqrte "Permalink to this headline") +# VarQRTE -`VarQRTE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)` +`VarQRTE(ansatz, initial_parameters, variational_principle=None, estimator=None, ode_solver=, lse_solver=None, num_timesteps=None, imag_part_tol=1e-07, num_instability_tol=1e-07)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/var_qrte.py "view source code") Bases: `qiskit.algorithms.time_evolvers.variational.var_qte.VarQTE`, [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.Eigensolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.Eigensolver.md index 82278bd3431..e31d73991b4 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.Eigensolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.Eigensolver.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.eigensolvers.Eigensolver --- -# Eigensolver[¶](#eigensolver "Permalink to this headline") +# Eigensolver -`Eigensolver` +`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute eigenvalues for an operator may implement this inter -`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)` +`abstract Eigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -45,7 +45,7 @@ An eigensolver result. -`classmethod Eigensolver.supports_aux_operators()` +`classmethod Eigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.EigensolverResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.EigensolverResult.md index 0d39dbb97e3..06b2f7194a9 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.EigensolverResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.EigensolverResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.eigensolvers.EigensolverResult --- -# EigensolverResult[¶](#eigensolverresult "Permalink to this headline") +# EigensolverResult -`EigensolverResult` +`EigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/eigensolver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolver.md index bcc83537883..caf05a725be 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolver.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolver --- -# NumPyEigensolver[¶](#numpyeigensolver "Permalink to this headline") +# NumPyEigensolver -`NumPyEigensolver(k=1, filter_criterion=None)` +`NumPyEigensolver(k=1, filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Bases: [`qiskit.algorithms.eigensolvers.eigensolver.Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") @@ -33,7 +33,7 @@ The NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valu -`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)` +`NumPyEigensolver.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -54,7 +54,7 @@ An eigensolver result. -`classmethod NumPyEigensolver.supports_aux_operators()` +`classmethod NumPyEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md index e8bf9f2a586..dbc5510a9a8 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.NumPyEigensolverResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.eigensolvers.NumPyEigensolverResult --- -# NumPyEigensolverResult[¶](#numpyeigensolverresult "Permalink to this headline") +# NumPyEigensolverResult -`NumPyEigensolverResult` +`NumPyEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/numpy_eigensolver.py "view source code") Bases: [`qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQD.md b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQD.md index d299070f1df..3ed7f69b21c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQD.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQD.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.eigensolvers.VQD --- -# VQD[¶](#vqd "Permalink to this headline") +# VQD -`VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)` +`VQD(estimator, fidelity, ansatz, optimizer, *, k=2, betas=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.eigensolvers.eigensolver.Eigensolver`](qiskit.algorithms.eigensolvers.Eigensolver "qiskit.algorithms.eigensolvers.eigensolver.Eigensolver") @@ -88,8 +88,6 @@ Beta parameters in the VQD paper. Should have length k - 1, with k the number of list\[float] - - ### initial point An optional initial point (i.e. initial parameter values) for the optimizer. If `None` then VQD will look to the ansatz for a preferred point and if not will simply compute a random one. @@ -125,7 +123,7 @@ Callable\[\[int, np.ndarray, float, dict\[str, Any]], None] | None -`VQD.compute_eigenvalues(operator, aux_operators=None)` +`VQD.compute_eigenvalues(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -146,7 +144,7 @@ An eigensolver result. -`classmethod VQD.supports_aux_operators()` +`classmethod VQD.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQDResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQDResult.md index 71db1b200d6..f6f4dabd863 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQDResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.VQDResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.eigensolvers.VQDResult --- -# VQDResult[¶](#vqdresult "Permalink to this headline") +# VQDResult -`VQDResult` +`VQDResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/eigensolvers/vqd.py "view source code") Bases: [`qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult`](qiskit.algorithms.eigensolvers.EigensolverResult "qiskit.algorithms.eigensolvers.eigensolver.EigensolverResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.md b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.md index e39051f921b..85b4bee7c28 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eigensolvers.md @@ -1,10 +1,10 @@ -# qiskit.algorithms.eigensolvers[¶](#module-qiskit.algorithms.eigensolvers "Permalink to this headline") +# qiskit.algorithms.eigensolvers -## Eigensolvers Package ([`qiskit.algorithms.eigensolvers`](#module-qiskit.algorithms.eigensolvers "qiskit.algorithms.eigensolvers"))[¶](#eigensolvers-package-qiskit-algorithms-eigensolvers "Permalink to this headline") +## Eigensolvers Package ([`qiskit.algorithms.eigensolvers`](#module-qiskit.algorithms.eigensolvers "qiskit.algorithms.eigensolvers")) -### Eigensolvers[¶](#eigensolvers "Permalink to this headline") +### Eigensolvers | | | | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------- | @@ -12,7 +12,7 @@ | [`NumPyEigensolver`](qiskit.algorithms.eigensolvers.NumPyEigensolver "qiskit.algorithms.eigensolvers.NumPyEigensolver")(\[k, filter\_criterion]) | The NumPy eigensolver algorithm. | | [`VQD`](qiskit.algorithms.eigensolvers.VQD "qiskit.algorithms.eigensolvers.VQD")(estimator, fidelity, ansatz, optimizer, \*) | The Variational Quantum Deflation algorithm. | -### Results[¶](#results "Permalink to this headline") +### Results > | | | > | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.estimate_observables.md b/docs/api/qiskit/0.41/qiskit.algorithms.estimate_observables.md index a511f5dd8f1..c689df56ba5 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.estimate_observables.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.estimate_observables.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.algorithms.estimate_observables --- -# qiskit.algorithms.estimate\_observables[¶](#qiskit-algorithms-estimate-observables "Permalink to this headline") +# qiskit.algorithms.estimate\_observables -`estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)` +`estimate_observables(estimator, quantum_state, observables, parameter_values=None, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/observables_evaluator.py "view source code") Accepts a sequence of operators and calculates their expectation values - means and metadata. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.eval_observables.md b/docs/api/qiskit/0.41/qiskit.algorithms.eval_observables.md index 6f723a1bd98..cad0372fb98 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.eval_observables.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.eval_observables.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.algorithms.eval_observables --- -# qiskit.algorithms.eval\_observables[¶](#qiskit-algorithms-eval-observables "Permalink to this headline") +# qiskit.algorithms.eval\_observables -`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)` +`eval_observables(quantum_instance, quantum_state, observables, expectation, threshold=1e-12)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/aux_ops_evaluator.py "view source code") Pending deprecation: Accepts a list or a dictionary of operators and calculates their expectation values - means and standard deviations. They are calculated with respect to a quantum state provided. A user can optionally provide a threshold value which filters mean values falling below the threshold. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseEstimatorGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseEstimatorGradient.md index 7b8b348a846..5e4df6bfa86 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseEstimatorGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseEstimatorGradient.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.BaseEstimatorGradient --- -# BaseEstimatorGradient[¶](#baseestimatorgradient "Permalink to this headline") +# BaseEstimatorGradient -`BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)` +`BaseEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") Bases: `abc.ABC` @@ -38,7 +38,7 @@ Base class for an `EstimatorGradient` to compute the gradients of the expectatio -`BaseEstimatorGradient.run(circuits, observables, parameter_values, parameters=None, **options)` +`BaseEstimatorGradient.run(circuits, observables, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") Run the job of the estimator gradient on the given circuits. @@ -62,7 +62,7 @@ The job object of the gradients of the expectation values. The i-th result corre -`BaseEstimatorGradient.update_default_options(**options)` +`BaseEstimatorGradient.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_estimator_gradient.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseQGT.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseQGT.md index 3697c0b520d..f94dec0097b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseQGT.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseQGT.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.BaseQGT --- -# BaseQGT[¶](#baseqgt "Permalink to this headline") +# BaseQGT -`BaseQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)` +`BaseQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") Bases: `abc.ABC` @@ -60,7 +60,7 @@ $$ -`BaseQGT.run(circuits, parameter_values, parameters=None, **options)` +`BaseQGT.run(circuits, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") Run the job of the QGTs on the given circuits. @@ -83,7 +83,7 @@ The job object of the QGTs of the expectation values. The i-th result correspond -`BaseQGT.update_default_options(**options)` +`BaseQGT.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_qgt.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseSamplerGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseSamplerGradient.md index e4afdf56726..2d22d7a7754 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseSamplerGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.BaseSamplerGradient.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.BaseSamplerGradient --- -# BaseSamplerGradient[¶](#basesamplergradient "Permalink to this headline") +# BaseSamplerGradient -`BaseSamplerGradient(sampler, options=None)` +`BaseSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") Bases: `abc.ABC` @@ -27,7 +27,7 @@ Base class for a `SamplerGradient` to compute the gradients of the sampling prob -`BaseSamplerGradient.run(circuits, parameter_values, parameters=None, **options)` +`BaseSamplerGradient.run(circuits, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") Run the job of the sampler gradient on the given circuits. @@ -50,7 +50,7 @@ The job object of the gradients of the sampling probability. The i-th result cor -`BaseSamplerGradient.update_default_options(**options)` +`BaseSamplerGradient.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/base_sampler_gradient.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.DerivativeType.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.DerivativeType.md index dbacfaaf904..98ef0803fe6 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.DerivativeType.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.DerivativeType.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.DerivativeType --- -# DerivativeType[¶](#derivativetype "Permalink to this headline") +# DerivativeType -`DerivativeType(value)` +`DerivativeType(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/utils.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.EstimatorGradientResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.EstimatorGradientResult.md index b8ae3b8e7bb..a2fca87a37f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.EstimatorGradientResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.EstimatorGradientResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.EstimatorGradientResult --- -# EstimatorGradientResult[¶](#estimatorgradientresult "Permalink to this headline") +# EstimatorGradientResult -`EstimatorGradientResult(gradients, metadata, options)` +`EstimatorGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/estimator_gradient_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md index 0d8436f2583..7a3ea6bbff5 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffEstimatorGradient.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.FiniteDiffEstimatorGradient --- -# FiniteDiffEstimatorGradient[¶](#finitediffestimatorgradient "Permalink to this headline") +# FiniteDiffEstimatorGradient -`FiniteDiffEstimatorGradient(estimator, epsilon, options=None, *, method='central')` +`FiniteDiffEstimatorGradient(estimator, epsilon, options=None, *, method='central')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/finite_diff_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md index 695d5342344..4aa3b6cf615 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.FiniteDiffSamplerGradient.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.FiniteDiffSamplerGradient --- -# FiniteDiffSamplerGradient[¶](#finitediffsamplergradient "Permalink to this headline") +# FiniteDiffSamplerGradient -`FiniteDiffSamplerGradient(sampler, epsilon, options=None, *, method='central')` +`FiniteDiffSamplerGradient(sampler, epsilon, options=None, *, method='central')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/finite_diff_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombEstimatorGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombEstimatorGradient.md index bbc13799a17..bf3595aec0c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombEstimatorGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombEstimatorGradient.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.LinCombEstimatorGradient --- -# LinCombEstimatorGradient[¶](#lincombestimatorgradient "Permalink to this headline") +# LinCombEstimatorGradient -`LinCombEstimatorGradient(estimator, derivative_type=DerivativeType.REAL, options=None)` +`LinCombEstimatorGradient(estimator, derivative_type=DerivativeType.REAL, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombQGT.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombQGT.md index 76e83de70fe..8bc161d035f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombQGT.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombQGT.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.LinCombQGT --- -# LinCombQGT[¶](#lincombqgt "Permalink to this headline") +# LinCombQGT -`LinCombQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)` +`LinCombQGT(estimator, phase_fix=True, derivative_type=DerivativeType.COMPLEX, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_qgt.py "view source code") Bases: [`qiskit.algorithms.gradients.base_qgt.BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base_qgt.BaseQGT") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombSamplerGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombSamplerGradient.md index 8844a4d39fa..d2551d95342 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombSamplerGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.LinCombSamplerGradient.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.LinCombSamplerGradient --- -# LinCombSamplerGradient[¶](#lincombsamplergradient "Permalink to this headline") +# LinCombSamplerGradient -`LinCombSamplerGradient(sampler, options=None)` +`LinCombSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/lin_comb_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md index efa86d51ab0..4a835296c52 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftEstimatorGradient.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.ParamShiftEstimatorGradient --- -# ParamShiftEstimatorGradient[¶](#paramshiftestimatorgradient "Permalink to this headline") +# ParamShiftEstimatorGradient -`ParamShiftEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)` +`ParamShiftEstimatorGradient(estimator, options=None, derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/param_shift_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md index 23ba5495921..254b6f2ac6b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ParamShiftSamplerGradient.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.ParamShiftSamplerGradient --- -# ParamShiftSamplerGradient[¶](#paramshiftsamplergradient "Permalink to this headline") +# ParamShiftSamplerGradient -`ParamShiftSamplerGradient(sampler, options=None)` +`ParamShiftSamplerGradient(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/param_shift_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFI.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFI.md index 9cc9ec5962a..ce591d94d0b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFI.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFI.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.QFI --- -# QFI[¶](#qfi "Permalink to this headline") +# QFI -`QFI(qgt, options=None)` +`QFI(qgt, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") Bases: `abc.ABC` @@ -32,7 +32,7 @@ $$ -`QFI.run(circuits, parameter_values, parameters=None, **options)` +`QFI.run(circuits, parameter_values, parameters=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") Run the job of the QFIs on the given circuits. @@ -51,7 +51,7 @@ The job object of the QFIs of the expectation values. The i-th result correspond -`QFI.update_default_options(**options)` +`QFI.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi.py "view source code") Update the gradient’s default options setting. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFIResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFIResult.md index e0136ce1c2e..ec72cc7bf99 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFIResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QFIResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.QFIResult --- -# QFIResult[¶](#qfiresult "Permalink to this headline") +# QFIResult -`QFIResult(qfis, metadata, options)` +`QFIResult(qfis, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qfi_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QGTResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QGTResult.md index 3a99fccdce1..a5d30dc28b7 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QGTResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.QGTResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.QGTResult --- -# QGTResult[¶](#qgtresult "Permalink to this headline") +# QGTResult -`QGTResult(qgts, derivative_type, metadata, options)` +`QGTResult(qgts, derivative_type, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/qgt_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseEstimatorGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseEstimatorGradient.md index 439c0efa0ae..b5a3a460fc4 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseEstimatorGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseEstimatorGradient.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.ReverseEstimatorGradient --- -# ReverseEstimatorGradient[¶](#reverseestimatorgradient "Permalink to this headline") +# ReverseEstimatorGradient -`ReverseEstimatorGradient(derivative_type=DerivativeType.REAL)` +`ReverseEstimatorGradient(derivative_type=DerivativeType.REAL)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/reverse_gradient/reverse_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseQGT.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseQGT.md index de070c86e8f..1c7d04f66f2 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseQGT.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.ReverseQGT.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.ReverseQGT --- -# ReverseQGT[¶](#reverseqgt "Permalink to this headline") +# ReverseQGT -`ReverseQGT(phase_fix=True, derivative_type=DerivativeType.COMPLEX)` +`ReverseQGT(phase_fix=True, derivative_type=DerivativeType.COMPLEX)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/reverse_gradient/reverse_qgt.py "view source code") Bases: [`qiskit.algorithms.gradients.base_qgt.BaseQGT`](qiskit.algorithms.gradients.BaseQGT "qiskit.algorithms.gradients.base_qgt.BaseQGT") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSAEstimatorGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSAEstimatorGradient.md index d7141f6e8be..08a3c462dde 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSAEstimatorGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSAEstimatorGradient.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.SPSAEstimatorGradient --- -# SPSAEstimatorGradient[¶](#spsaestimatorgradient "Permalink to this headline") +# SPSAEstimatorGradient -`SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, options=None)` +`SPSAEstimatorGradient(estimator, epsilon, batch_size=1, seed=None, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/spsa_estimator_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient`](qiskit.algorithms.gradients.BaseEstimatorGradient "qiskit.algorithms.gradients.base_estimator_gradient.BaseEstimatorGradient") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSASamplerGradient.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSASamplerGradient.md index e5ec671591f..bac2f7cb3d4 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSASamplerGradient.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SPSASamplerGradient.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.SPSASamplerGradient --- -# SPSASamplerGradient[¶](#spsasamplergradient "Permalink to this headline") +# SPSASamplerGradient -`SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, options=None)` +`SPSASamplerGradient(sampler, epsilon, batch_size=1, seed=None, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/spsa_sampler_gradient.py "view source code") Bases: [`qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient`](qiskit.algorithms.gradients.BaseSamplerGradient "qiskit.algorithms.gradients.base_sampler_gradient.BaseSamplerGradient") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SamplerGradientResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SamplerGradientResult.md index 487633ffb08..aeeb3337e8c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SamplerGradientResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.SamplerGradientResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.gradients.SamplerGradientResult --- -# SamplerGradientResult[¶](#samplergradientresult "Permalink to this headline") +# SamplerGradientResult -`SamplerGradientResult(gradients, metadata, options)` +`SamplerGradientResult(gradients, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/gradients/sampler_gradient_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.md b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.md index 6fc9cabf555..7b8988f878a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.gradients.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.gradients.md @@ -1,10 +1,10 @@ -# qiskit.algorithms.gradients[¶](#module-qiskit.algorithms.gradients "Permalink to this headline") +# qiskit.algorithms.gradients -## Gradients ([`qiskit.algorithms.gradients`](#module-qiskit.algorithms.gradients "qiskit.algorithms.gradients"))[¶](#gradients-qiskit-algorithms-gradients "Permalink to this headline") +## Gradients ([`qiskit.algorithms.gradients`](#module-qiskit.algorithms.gradients "qiskit.algorithms.gradients")) -### Estimator Gradients[¶](#estimator-gradients "Permalink to this headline") +### Estimator Gradients | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | @@ -16,7 +16,7 @@ | [`SPSAEstimatorGradient`](qiskit.algorithms.gradients.SPSAEstimatorGradient "qiskit.algorithms.gradients.SPSAEstimatorGradient")(estimator, epsilon\[, ...]) | Compute the gradients of the expectation value by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. | | [`ReverseEstimatorGradient`](qiskit.algorithms.gradients.ReverseEstimatorGradient "qiskit.algorithms.gradients.ReverseEstimatorGradient")(\[derivative\_type]) | Estimator gradients with the classically efficient reverse mode. | -### Sampler Gradients[¶](#sampler-gradients "Permalink to this headline") +### Sampler Gradients | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | @@ -26,7 +26,7 @@ | [`ParamShiftSamplerGradient`](qiskit.algorithms.gradients.ParamShiftSamplerGradient "qiskit.algorithms.gradients.ParamShiftSamplerGradient")(sampler\[, options]) | Compute the gradients of the sampling probability by the parameter shift rule \[1]. | | [`SPSASamplerGradient`](qiskit.algorithms.gradients.SPSASamplerGradient "qiskit.algorithms.gradients.SPSASamplerGradient")(sampler, epsilon\[, ...]) | Compute the gradients of the sampling probability by the Simultaneous Perturbation Stochastic Approximation (SPSA) \[1]. | -### Quantum Geometric Tensor[¶](#quantum-geometric-tensor "Permalink to this headline") +### Quantum Geometric Tensor | | | | -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | @@ -35,7 +35,7 @@ | [`QFI`](qiskit.algorithms.gradients.QFI "qiskit.algorithms.gradients.QFI")(qgt\[, options]) | Computes the Quantum Fisher Information (QFI) given a pure, parameterized quantum state. | | [`ReverseQGT`](qiskit.algorithms.gradients.ReverseQGT "qiskit.algorithms.gradients.ReverseQGT")(\[phase\_fix, derivative\_type]) | QGT calculation with the classically efficient reverse mode. | -### Results[¶](#results "Permalink to this headline") +### Results | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.AbsoluteAverage.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.AbsoluteAverage.md index 0ba98ad4d86..d1e90cdb595 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.AbsoluteAverage.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.AbsoluteAverage.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.linear_solvers.AbsoluteAverage --- -# AbsoluteAverage[¶](#absoluteaverage "Permalink to this headline") +# AbsoluteAverage -`AbsoluteAverage` +`AbsoluteAverage`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") @@ -57,7 +57,7 @@ exact = observable.evaluate_classically(init_state) -`AbsoluteAverage.evaluate_classically(solution)` +`AbsoluteAverage.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Evaluates the given observable on the solution to the linear system. @@ -77,7 +77,7 @@ The value of the observable. -`AbsoluteAverage.observable(num_qubits)` +`AbsoluteAverage.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") The observable operator. @@ -97,7 +97,7 @@ The observable as a sum of Pauli strings. -`AbsoluteAverage.observable_circuit(num_qubits)` +`AbsoluteAverage.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") The circuit implementing the absolute average observable. @@ -117,7 +117,7 @@ The observable as a QuantumCircuit. -`AbsoluteAverage.post_processing(solution, num_qubits, scaling=1)` +`AbsoluteAverage.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/absolute_average.py "view source code") Evaluates the absolute average on the solution to the linear system. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.HHL.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.HHL.md index 369fb207329..0a400b3ed5d 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.HHL.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.HHL.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.linear_solvers.HHL --- -# HHL[¶](#hhl "Permalink to this headline") +# HHL -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") @@ -73,7 +73,7 @@ Enhancing the Quantum Linear Systems Algorithm Using Richardson Extrapolation. [ -`HHL.construct_circuit(matrix, vector, neg_vals=True)` +`HHL.construct_circuit(matrix, vector, neg_vals=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") Construct the HHL circuit. @@ -101,7 +101,7 @@ The HHL circuit. -`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` +`HHL.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/hhl.py "view source code") Tries to solve the given linear system of equations. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolver.md index 7bbab7a44d6..3eac543ee0c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolver.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.linear_solvers.LinearSolver --- -# LinearSolver[¶](#linearsolver "Permalink to this headline") +# LinearSolver -`LinearSolver` +`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The deprecated abstract class for linear system solvers in Qiskit. -`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` +`abstract LinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Solve the system and compute the observable(s) diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolverResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolverResult.md index ba7b1d5f25b..05b6cc4c8e8 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolverResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSolverResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.linear_solvers.LinearSolverResult --- -# LinearSolverResult[¶](#linearsolverresult "Permalink to this headline") +# LinearSolverResult -`LinearSolverResult` +`LinearSolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md index d5592aa8245..f91dd1f0728 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemMatrix.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.linear_solvers.LinearSystemMatrix --- -# LinearSystemMatrix[¶](#linearsystemmatrix "Permalink to this headline") +# LinearSystemMatrix -`LinearSystemMatrix(num_state_qubits, tolerance, evolution_time, name='ls_matrix')` +`LinearSystemMatrix(num_state_qubits, tolerance, evolution_time, name='ls_matrix')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` @@ -491,7 +491,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`abstract LinearSystemMatrix.condition_bounds()` +`abstract LinearSystemMatrix.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1142,7 +1142,7 @@ A handle to the instructions created. -`abstract LinearSystemMatrix.eigs_bounds()` +`abstract LinearSystemMatrix.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -2141,7 +2141,7 @@ A handle to the instructions created. -`abstract LinearSystemMatrix.power(power, matrix_power=False)` +`abstract LinearSystemMatrix.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/linear_system_matrix.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemObservable.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemObservable.md index 3d50750b2d2..307eb9c7133 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemObservable.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.LinearSystemObservable.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.linear_solvers.LinearSystemObservable --- -# LinearSystemObservable[¶](#linearsystemobservable "Permalink to this headline") +# LinearSystemObservable -`LinearSystemObservable` +`LinearSystemObservable`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The deprecated abstract class for linear system observables in Qiskit. -`abstract LinearSystemObservable.evaluate_classically(solution)` +`abstract LinearSystemObservable.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") #### Calculates the analytical value of the given observable from the solution vector to the @@ -44,7 +44,7 @@ The value of the observable. -`abstract LinearSystemObservable.observable(num_qubits)` +`abstract LinearSystemObservable.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") The observable operator. @@ -64,7 +64,7 @@ The observable as a sum of Pauli strings. -`abstract LinearSystemObservable.observable_circuit(num_qubits)` +`abstract LinearSystemObservable.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") The circuit implementing the observable. @@ -84,7 +84,7 @@ The observable as a QuantumCircuit. -`abstract LinearSystemObservable.post_processing(solution, num_qubits, scaling=1)` +`abstract LinearSystemObservable.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/linear_system_observable.py "view source code") Evaluates the given observable on the solution to the linear system. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.MatrixFunctional.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.MatrixFunctional.md index 288a554fc7f..496e1c64d28 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.MatrixFunctional.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.MatrixFunctional.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.linear_solvers.MatrixFunctional --- -# MatrixFunctional[¶](#matrixfunctional "Permalink to this headline") +# MatrixFunctional -`MatrixFunctional(main_diag, off_diag)` +`MatrixFunctional(main_diag, off_diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable`](qiskit.algorithms.linear_solvers.LinearSystemObservable "qiskit.algorithms.linear_solvers.observables.linear_system_observable.LinearSystemObservable") @@ -72,7 +72,7 @@ exact = observable.evaluate_classically(init_state) -`MatrixFunctional.evaluate_classically(solution)` +`MatrixFunctional.evaluate_classically(solution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Evaluates the given observable on the solution to the linear system. @@ -92,7 +92,7 @@ The value of the observable. -`MatrixFunctional.observable(num_qubits)` +`MatrixFunctional.observable(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") The observable operators. @@ -112,7 +112,7 @@ The observable as a list of sums of Pauli strings. -`MatrixFunctional.observable_circuit(num_qubits)` +`MatrixFunctional.observable_circuit(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") The circuits to implement the matrix functional observable. @@ -132,7 +132,7 @@ The observable as a list of QuantumCircuits. -`MatrixFunctional.post_processing(solution, num_qubits, scaling=1)` +`MatrixFunctional.post_processing(solution, num_qubits, scaling=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/observables/matrix_functional.py "view source code") Evaluates the matrix functional on the solution to the linear system. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md index ab6c42bc4cd..6023d2b249c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyLinearSolver.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.linear_solvers.NumPyLinearSolver --- -# NumPyLinearSolver[¶](#numpylinearsolver "Permalink to this headline") +# NumPyLinearSolver -`NumPyLinearSolver` +`NumPyLinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.linear_solver.LinearSolver`](qiskit.algorithms.linear_solvers.LinearSolver "qiskit.algorithms.linear_solvers.linear_solver.LinearSolver") @@ -47,7 +47,7 @@ result = solution.observable -`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)` +`NumPyLinearSolver.solve(matrix, vector, observable=None, observable_circuit=None, post_processing=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/numpy_linear_solver.py "view source code") Solve classically the linear system and compute the observable(s) diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyMatrix.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyMatrix.md index 9df31b71fea..a08adddb955 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyMatrix.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.NumPyMatrix.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.linear_solvers.NumPyMatrix --- -# NumPyMatrix[¶](#numpymatrix "Permalink to this headline") +# NumPyMatrix -`NumPyMatrix(matrix, tolerance=0.01, evolution_time=1.0, name='np_matrix')` +`NumPyMatrix(matrix, tolerance=0.01, evolution_time=1.0, name='np_matrix')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") @@ -513,7 +513,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`NumPyMatrix.condition_bounds()` +`NumPyMatrix.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1164,7 +1164,7 @@ A handle to the instructions created. -`NumPyMatrix.eigs_bounds()` +`NumPyMatrix.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Return lower and upper bounds on the eigenvalues of the matrix. @@ -1673,7 +1673,7 @@ q_1: ┤1 ├ -`NumPyMatrix.inverse()` +`NumPyMatrix.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Invert (take adjoint of) this circuit. @@ -2163,7 +2163,7 @@ A handle to the instructions created. -`NumPyMatrix.power(power, matrix_power=False)` +`NumPyMatrix.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/numpy_matrix.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md index 8865f5c10ed..872257b6175 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.TridiagonalToeplitz.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.linear_solvers.TridiagonalToeplitz --- -# TridiagonalToeplitz[¶](#tridiagonaltoeplitz "Permalink to this headline") +# TridiagonalToeplitz -`TridiagonalToeplitz(num_state_qubits, main_diag, off_diag, tolerance=0.01, evolution_time=1.0, trotter_steps=1, name='tridi')` +`TridiagonalToeplitz(num_state_qubits, main_diag, off_diag, tolerance=0.01, evolution_time=1.0, trotter_steps=1, name='tridi')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Bases: [`qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix`](qiskit.algorithms.linear_solvers.LinearSystemMatrix "qiskit.algorithms.linear_solvers.matrices.linear_system_matrix.LinearSystemMatrix") @@ -526,7 +526,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`TridiagonalToeplitz.condition_bounds()` +`TridiagonalToeplitz.condition_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Return lower and upper bounds on the condition number of the matrix. @@ -1177,7 +1177,7 @@ A handle to the instructions created. -`TridiagonalToeplitz.eigs_bounds()` +`TridiagonalToeplitz.eigs_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Return lower and upper bounds on the absolute eigenvalues of the matrix. @@ -1686,7 +1686,7 @@ q_1: ┤1 ├ -`TridiagonalToeplitz.inverse()` +`TridiagonalToeplitz.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Invert (take adjoint of) this circuit. @@ -2176,7 +2176,7 @@ A handle to the instructions created. -`TridiagonalToeplitz.power(power, matrix_power=False)` +`TridiagonalToeplitz.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/linear_solvers/matrices/tridiagonal_toeplitz.py "view source code") Build powers of the circuit. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.md b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.md index a20833f1986..572c4585cea 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.linear_solvers.md @@ -1,8 +1,8 @@ -# qiskit.algorithms.linear\_solvers[¶](#module-qiskit.algorithms.linear_solvers "Permalink to this headline") +# qiskit.algorithms.linear\_solvers -## The deprecated Linear solvers ([`qiskit.algorithms.linear_solvers`](#module-qiskit.algorithms.linear_solvers "qiskit.algorithms.linear_solvers"))[¶](#the-deprecated-linear-solvers-qiskit-algorithms-linear-solvers "Permalink to this headline") +## The deprecated Linear solvers ([`qiskit.algorithms.linear_solvers`](#module-qiskit.algorithms.linear_solvers "qiskit.algorithms.linear_solvers")) It contains classical and quantum algorithms to solve systems of linear equations such as `HHL`. Although the quantum algorithm accepts a general Hermitian matrix as input, Qiskit’s default Hamiltonian evolution is exponential in such cases and therefore the quantum linear solver will not achieve an exponential speedup. Furthermore, the quantum algorithm can find a solution exponentially faster in the size of the system than their classical counterparts (i.e. logarithmic complexity instead of polynomial), meaning that reading the full solution vector would kill such speedup (since this would take linear time in the size of the system). Therefore, to achieve an exponential speedup we can only compute functions from the solution vector (the so called observables) to learn information about the solution. Known efficient implementations of Hamiltonian evolutions or observables are contained in the following subfolders: @@ -14,7 +14,7 @@ A placeholder for efficient implementations of the Hamiltonian evolution of part A placeholder for efficient implementations of functions that can be computed from the solution vector to a system of linear equations. -## Linear Solvers[¶](#linear-solvers "Permalink to this headline") +## Linear Solvers | | | | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -23,7 +23,7 @@ A placeholder for efficient implementations of functions that can be computed fr | [`HHL`](qiskit.algorithms.linear_solvers.HHL "qiskit.algorithms.linear_solvers.HHL") | The deprecated systems of linear equations arise naturally in many real-life applications in a wide range of areas, such as in the solution of Partial Differential Equations, the calibration of financial models, fluid simulation or numerical field calculation. | | [`NumPyLinearSolver`](qiskit.algorithms.linear_solvers.NumPyLinearSolver "qiskit.algorithms.linear_solvers.NumPyLinearSolver") | The deprecated Numpy Linear Solver algorithm (classical). | -## Matrices[¶](#matrices "Permalink to this headline") +## Matrices | | | | ------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------- | @@ -31,7 +31,7 @@ A placeholder for efficient implementations of functions that can be computed fr | [`NumPyMatrix`](qiskit.algorithms.linear_solvers.NumPyMatrix "qiskit.algorithms.linear_solvers.NumPyMatrix") | The deprecated class of matrices given as a numpy array. | | [`TridiagonalToeplitz`](qiskit.algorithms.linear_solvers.TridiagonalToeplitz "qiskit.algorithms.linear_solvers.TridiagonalToeplitz") | The deprecated class of tridiagonal Toeplitz symmetric matrices. | -## Observables[¶](#observables "Permalink to this headline") +## Observables | | | | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md index dcebf09cf67..2cd666de64a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQE.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQE --- -# AdaptVQE[¶](#adaptvqe "Permalink to this headline") +# AdaptVQE -`AdaptVQE(solver, *, threshold=1e-05, max_iterations=None)` +`AdaptVQE(solver, *, threshold=1e-05, max_iterations=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") @@ -69,7 +69,7 @@ the maximum number of iterations for the adaptive loop. If `None`, the algorithm -`AdaptVQE.compute_minimum_eigenvalue(operator, aux_operators=None)` +`AdaptVQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Computes the minimum eigenvalue. @@ -95,7 +95,7 @@ An [`AdaptVQEResult`](qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult "qis -`classmethod AdaptVQE.supports_aux_operators()` +`classmethod AdaptVQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md index 85a4aa93fc3..50d105cc089 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.minimum_eigensolvers.AdaptVQEResult --- -# AdaptVQEResult[¶](#adaptvqeresult "Permalink to this headline") +# AdaptVQEResult -`AdaptVQEResult` +`AdaptVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/adapt_vqe.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult`](qiskit.algorithms.minimum_eigensolvers.VQEResult "qiskit.algorithms.minimum_eigensolvers.vqe.VQEResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md index 63168874bd0..8b4b8f60845 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver --- -# MinimumEigensolver[¶](#minimumeigensolver "Permalink to this headline") +# MinimumEigensolver -`MinimumEigensolver` +`MinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t -`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` +`abstract MinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -45,7 +45,7 @@ A minimum eigensolver result. -`classmethod MinimumEigensolver.supports_aux_operators()` +`classmethod MinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md index 7ec6cb51c43..8fd386db895 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult --- -# MinimumEigensolverResult[¶](#minimumeigensolverresult "Permalink to this headline") +# MinimumEigensolverResult -`MinimumEigensolverResult` +`MinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/minimum_eigensolver.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md index 49c4e114564..49b0154d470 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolver --- -# NumPyMinimumEigensolver[¶](#numpyminimumeigensolver "Permalink to this headline") +# NumPyMinimumEigensolver -`NumPyMinimumEigensolver(filter_criterion=None)` +`NumPyMinimumEigensolver(filter_criterion=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") @@ -26,7 +26,7 @@ The NumPy minimum eigensolver algorithm. -`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` +`NumPyMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -47,7 +47,7 @@ A minimum eigensolver result. -`classmethod NumPyMinimumEigensolver.supports_aux_operators()` +`classmethod NumPyMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md index 7ba8a1ed39e..6007ad2d4b9 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.minimum_eigensolvers.NumPyMinimumEigensolverResult --- -# NumPyMinimumEigensolverResult[¶](#numpyminimumeigensolverresult "Permalink to this headline") +# NumPyMinimumEigensolverResult -`NumPyMinimumEigensolverResult` +`NumPyMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/numpy_minimum_eigensolver.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.QAOA.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.QAOA.md index ea7e95a9a65..2e1f7de1e8d 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.QAOA.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.QAOA.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.minimum_eigensolvers.QAOA --- -# QAOA[¶](#qaoa "Permalink to this headline") +# QAOA -`QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)` +`QAOA(sampler, optimizer, *, reps=1, initial_state=None, mixer=None, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/qaoa.py "view source code") Bases: [`qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE`](qiskit.algorithms.minimum_eigensolvers.SamplingVQE "qiskit.algorithms.minimum_eigensolvers.sampling_vqe.SamplingVQE") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md index 7288ecbddac..05bf7bf2539 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver --- -# SamplingMinimumEigensolver[¶](#samplingminimumeigensolver "Permalink to this headline") +# SamplingMinimumEigensolver -`SamplingMinimumEigensolver` +`SamplingMinimumEigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ The Sampling Minimum Eigensolver Interface. -`abstract SamplingMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)` +`abstract SamplingMinimumEigensolver.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Compute the minimum eigenvalue of a diagonal operator. @@ -43,7 +43,7 @@ A [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.Sa -`classmethod SamplingMinimumEigensolver.supports_aux_operators()` +`classmethod SamplingMinimumEigensolver.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md index 6083c3f729b..1eba5396f4a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult --- -# SamplingMinimumEigensolverResult[¶](#samplingminimumeigensolverresult "Permalink to this headline") +# SamplingMinimumEigensolverResult -`SamplingMinimumEigensolverResult` +`SamplingMinimumEigensolverResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_mes.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md index eb6d0cb375c..2b449e5b1c3 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQE.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQE --- -# SamplingVQE[¶](#samplingvqe "Permalink to this headline") +# SamplingVQE -`SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)` +`SamplingVQE(sampler, ansatz, optimizer, *, initial_point=None, aggregation=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolver") @@ -123,7 +123,7 @@ Callable\[\[int, np.ndarray, float, dict\[str, Any]], None] | None -`SamplingVQE.compute_minimum_eigenvalue(operator, aux_operators=None)` +`SamplingVQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Compute the minimum eigenvalue of a diagonal operator. @@ -144,7 +144,7 @@ A [`SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.Sa -`classmethod SamplingVQE.supports_aux_operators()` +`classmethod SamplingVQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md index a1e0f00c98c..85ed351378f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.minimum_eigensolvers.SamplingVQEResult --- -# SamplingVQEResult[¶](#samplingvqeresult "Permalink to this headline") +# SamplingVQEResult -`SamplingVQEResult` +`SamplingVQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/sampling_vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.SamplingMinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.sampling_mes.SamplingMinimumEigensolverResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQE.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQE.md index b0903c6f7a1..6008deb3795 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQE.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQE.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.minimum_eigensolvers.VQE --- -# VQE[¶](#vqe "Permalink to this headline") +# VQE -`VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)` +`VQE(estimator, ansatz, optimizer, *, gradient=None, initial_point=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalAlgorithm`, [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolver "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolver") @@ -129,7 +129,7 @@ Callable\[\[int, np.ndarray, float, dict\[str, Any]], None] | None -`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)` +`VQE.compute_minimum_eigenvalue(operator, aux_operators=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Computes the minimum eigenvalue. The `operator` and `aux_operators` are supplied here. While an `operator` is required by algorithms, `aux_operators` are optional. @@ -150,7 +150,7 @@ A minimum eigensolver result. -`classmethod VQE.supports_aux_operators()` +`classmethod VQE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQEResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQEResult.md index d6aaf0f5f2f..4d9492dc3d8 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQEResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.VQEResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.minimum_eigensolvers.VQEResult --- -# VQEResult[¶](#vqeresult "Permalink to this headline") +# VQEResult -`VQEResult` +`VQEResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/minimum_eigensolvers/vqe.py "view source code") Bases: `qiskit.algorithms.variational_algorithm.VariationalResult`, [`qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult`](qiskit.algorithms.minimum_eigensolvers.MinimumEigensolverResult "qiskit.algorithms.minimum_eigensolvers.minimum_eigensolver.MinimumEigensolverResult") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.md b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.md index d8581d4f282..618bfe92c3d 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.minimum_eigensolvers.md @@ -1,10 +1,10 @@ -# qiskit.algorithms.minimum\_eigensolvers[¶](#module-qiskit.algorithms.minimum_eigensolvers "Permalink to this headline") +# qiskit.algorithms.minimum\_eigensolvers -## Minimum Eigensolvers Package ([`qiskit.algorithms.minimum_eigensolvers`](#module-qiskit.algorithms.minimum_eigensolvers "qiskit.algorithms.minimum_eigensolvers"))[¶](#minimum-eigensolvers-package-qiskit-algorithms-minimum-eigensolvers "Permalink to this headline") +## Minimum Eigensolvers Package ([`qiskit.algorithms.minimum_eigensolvers`](#module-qiskit.algorithms.minimum_eigensolvers "qiskit.algorithms.minimum_eigensolvers")) -### Minimum Eigensolvers[¶](#minimum-eigensolvers "Permalink to this headline") +### Minimum Eigensolvers | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ADAM.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ADAM.md index 54e93aaa206..e737a7d8a7e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ADAM.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.ADAM --- -# ADAM[¶](#adam "Permalink to this headline") +# ADAM -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -52,7 +52,7 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ -`ADAM.get_support_level()` +`ADAM.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Return support level dictionary @@ -83,7 +83,7 @@ grad -`ADAM.load_params(load_dir)` +`ADAM.load_params(load_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Load iteration parameters for a file called `adam_params.csv`. @@ -99,7 +99,7 @@ Load iteration parameters for a file called `adam_params.csv`. -`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)` +`ADAM.minimize(fun, x0, jac=None, bounds=None, objective_function=None, initial_point=None, gradient_function=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Minimize the scalar function. @@ -133,7 +133,7 @@ Print algorithm-specific options. -`ADAM.save_params(snapshot_dir)` +`ADAM.save_params(snapshot_dir)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Save the current iteration parameters to a file called `adam_params.csv`. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AQGD.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AQGD.md index 1e6a1c64719..8bd87981fe0 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AQGD.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.AQGD --- -# AQGD[¶](#aqgd "Permalink to this headline") +# AQGD -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -44,7 +44,7 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. -`AQGD.get_support_level()` +`AQGD.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") Support level dictionary @@ -85,7 +85,7 @@ grad -`AQGD.minimize(fun, x0, jac=None, bounds=None)` +`AQGD.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/aqgd.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AskData.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AskData.md index d6009c9b3a0..b28d6820b9e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AskData.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.AskData.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.AskData --- -# AskData[¶](#askdata "Permalink to this headline") +# AskData -`AskData(x_fun=None, x_jac=None)` +`AskData(x_fun=None, x_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.BOBYQA.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.BOBYQA.md index f015d0174a2..ec722dfbbe3 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.BOBYQA.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.BOBYQA --- -# BOBYQA[¶](#bobyqa "Permalink to this headline") +# BOBYQA -`BOBYQA(maxiter=1000)` +`BOBYQA(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`BOBYQA.get_support_level()` +`BOBYQA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`BOBYQA.minimize(fun, x0, jac=None, bounds=None)` +`BOBYQA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/bobyqa.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CG.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CG.md index e556fbc3190..b92f3958c08 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CG.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.CG --- -# CG[¶](#cg "Permalink to this headline") +# CG -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/cg.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.COBYLA.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.COBYLA.md index e11af503086..417ca0bc042 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.COBYLA.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.COBYLA --- -# COBYLA[¶](#cobyla "Permalink to this headline") +# COBYLA -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CRS.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CRS.md index 23206a142f9..044cdd62086 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.CRS.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.CRS --- -# CRS[¶](#crs "Permalink to this headline") +# CRS -`CRS(max_evals=1000)` +`CRS(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`CRS.get_nlopt_optimizer()` +`CRS.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/crs.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L.md index c8d7822cee4..0a48df3a05e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.DIRECT_L --- -# DIRECT\_L[¶](#direct-l "Permalink to this headline") +# DIRECT\_L -`DIRECT_L(max_evals=1000)` +`DIRECT_L(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L.get_nlopt_optimizer()` +`DIRECT_L.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L_RAND.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L_RAND.md index b7c49067246..e87f0d2c37d 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L_RAND.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.DIRECT_L_RAND.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND --- -# DIRECT\_L\_RAND[¶](#direct-l-rand "Permalink to this headline") +# DIRECT\_L\_RAND -`DIRECT_L_RAND(max_evals=1000)` +`DIRECT_L_RAND(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`DIRECT_L_RAND.get_nlopt_optimizer()` +`DIRECT_L_RAND.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/direct_l_rand.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ESCH.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ESCH.md index 07833831810..0015cb6720e 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ESCH.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.ESCH --- -# ESCH[¶](#esch "Permalink to this headline") +# ESCH -`ESCH(max_evals=1000)` +`ESCH(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -36,7 +36,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to -`ESCH.get_nlopt_optimizer()` +`ESCH.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/esch.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GSLS.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GSLS.md index d38ba900d3c..011adfd6903 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GSLS.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.GSLS --- -# GSLS[¶](#gsls "Permalink to this headline") +# GSLS -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -42,7 +42,7 @@ An implementation of the line search algorithm described in [https://arxiv.org/p -`GSLS.get_support_level()` +`GSLS.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Return support level dictionary. @@ -58,7 +58,7 @@ A dictionary containing the support levels for different options. -`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)` +`GSLS.gradient_approximation(n, x, x_value, directions, sample_set_x, sample_set_y)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Construct gradient approximation from given sample. @@ -106,7 +106,7 @@ grad -`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)` +`GSLS.ls_optimize(n, obj_fun, initial_point, var_lb, var_ub)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Run the line search optimization. @@ -134,7 +134,7 @@ Final iterate as a vector, corresponding objective function value, number of eva -`GSLS.minimize(fun, x0, jac=None, bounds=None)` +`GSLS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Minimize the scalar function. @@ -165,7 +165,7 @@ Print algorithm-specific options. -`GSLS.sample_points(n, x, num_points)` +`GSLS.sample_points(n, x, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Sample `num_points` points around `x` on the `n`-sphere of specified radius. @@ -189,7 +189,7 @@ A tuple containing the sampling points and the directions. -`GSLS.sample_set(n, x, var_lb, var_ub, num_points)` +`GSLS.sample_set(n, x, var_lb, var_ub, num_points)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gsls.py "view source code") Construct sample set of given size. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescent.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescent.md index a485f90dae1..d9adca00e49 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescent.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.GradientDescent --- -# GradientDescent[¶](#gradientdescent "Permalink to this headline") +# GradientDescent -`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` +`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer`](qiskit.algorithms.optimizers.SteppableOptimizer "qiskit.algorithms.optimizers.steppable_optimizer.SteppableOptimizer") @@ -141,7 +141,7 @@ To see other libraries that use this interface one can visit: [https://optuna.re -`GradientDescent.ask()` +`GradientDescent.ask()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Returns an object with the data needed to evaluate the gradient. @@ -155,7 +155,7 @@ If this object contains a gradient function the gradient can be evaluated direct -`GradientDescent.continue_condition()` +`GradientDescent.continue_condition()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Condition that indicates the optimization process should come to an end. @@ -173,7 +173,7 @@ When the stepsize is smaller than the tolerance, the optimization process is con -`GradientDescent.create_result()` +`GradientDescent.create_result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Creates a result of the optimization process. @@ -191,7 +191,7 @@ The result of the optimization process. -`GradientDescent.evaluate(ask_data)` +`GradientDescent.evaluate(ask_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Evaluates the gradient. @@ -213,7 +213,7 @@ The data containing the gradient evaluation. -`GradientDescent.get_support_level()` +`GradientDescent.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Get the support level dictionary. @@ -299,7 +299,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`GradientDescent.start(fun, x0, jac=None, bounds=None)` +`GradientDescent.start(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Populates the state of the optimizer with the data provided and sets all the counters to 0. @@ -332,7 +332,7 @@ This method composes [`ask()`](qiskit.algorithms.optimizers.GradientDescent#ask -`GradientDescent.tell(ask_data, tell_data)` +`GradientDescent.tell(ask_data, tell_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Updates `x` by an ammount proportional to the learning rate and value of the gradient at that point. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescentState.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescentState.md index 4b93e0ff5f1..8263430eb27 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescentState.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.GradientDescentState.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.GradientDescentState --- -# GradientDescentState[¶](#gradientdescentstate "Permalink to this headline") +# GradientDescentState -`GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)` +`GradientDescentState(x, fun, jac, nfev, njev, nit, stepsize, learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: [`qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.steppable_optimizer.OptimizerState") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.IMFIL.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.IMFIL.md index be66e233c7b..4c26cf619a9 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.IMFIL.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.IMFIL --- -# IMFIL[¶](#imfil "Permalink to this headline") +# IMFIL -`IMFIL(maxiter=1000)` +`IMFIL(maxiter=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -34,7 +34,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`IMFIL.get_support_level()` +`IMFIL.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") Returns support level dictionary. @@ -65,7 +65,7 @@ grad -`IMFIL.minimize(fun, x0, jac=None, bounds=None)` +`IMFIL.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/imfil.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ISRES.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ISRES.md index 72c0ec4166e..a6338965582 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.ISRES.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.ISRES --- -# ISRES[¶](#isres "Permalink to this headline") +# ISRES -`ISRES(max_evals=1000)` +`ISRES(max_evals=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Bases: `qiskit.algorithms.optimizers.nlopts.nloptimizer.NLoptOptimizer` @@ -34,7 +34,7 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht -`ISRES.get_nlopt_optimizer()` +`ISRES.get_nlopt_optimizer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nlopts/isres.py "view source code") Return NLopt optimizer type diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.L_BFGS_B.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.L_BFGS_B.md index 6c9aec07dd4..f4d82e90623 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.L_BFGS_B.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.L_BFGS_B.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.L_BFGS_B --- -# L\_BFGS\_B[¶](#l-bfgs-b "Permalink to this headline") +# L\_BFGS\_B -`L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=- 1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` +`L_BFGS_B(maxfun=15000, maxiter=15000, ftol=2.220446049250313e-15, iprint=- 1, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/l_bfgs_b.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Minimizer.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Minimizer.md index 32be4f6c353..07fd105ce15 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Minimizer.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Minimizer.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.Minimizer --- -# Minimizer[¶](#minimizer "Permalink to this headline") +# Minimizer -`Minimizer(*args, **kwargs)` +`Minimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `Protocol` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NELDER_MEAD.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NELDER_MEAD.md index 276201249db..9107ba9826f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NELDER_MEAD.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NELDER_MEAD.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD --- -# NELDER\_MEAD[¶](#nelder-mead "Permalink to this headline") +# NELDER\_MEAD -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NFT.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NFT.md index 3a6d0976929..d3583ffd1d1 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.NFT.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.NFT --- -# NFT[¶](#nft "Permalink to this headline") +# NFT -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/nft.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Optimizer.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Optimizer.md index 1060bcac634..8fd99c5dcc5 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.Optimizer.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.Optimizer --- -# Optimizer[¶](#optimizer "Permalink to this headline") +# Optimizer -`Optimizer` +`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ -`abstract Optimizer.get_support_level()` +`abstract Optimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Return support level dictionary @@ -32,7 +32,7 @@ Return support level dictionary -`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=None)` +`static Optimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. @@ -55,7 +55,7 @@ grad -`abstract Optimizer.minimize(fun, x0, jac=None, bounds=None)` +`abstract Optimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Minimize the scalar function. @@ -78,7 +78,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`Optimizer.print_options()` +`Optimizer.print_options()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Print algorithm-specific options. @@ -86,7 +86,7 @@ Print algorithm-specific options. -`Optimizer.set_max_evals_grouped(limit)` +`Optimizer.set_max_evals_grouped(limit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Set max evals grouped @@ -94,7 +94,7 @@ Set max evals grouped -`Optimizer.set_options(**kwargs)` +`Optimizer.set_options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Sets or updates values in the options dictionary. @@ -108,7 +108,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`static Optimizer.wrap_function(function, args)` +`static Optimizer.wrap_function(function, args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Wrap the function to implicitly inject the args at the call of the function. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerResult.md index f585236defc..5bc94cce554 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.OptimizerResult --- -# OptimizerResult[¶](#optimizerresult "Permalink to this headline") +# OptimizerResult -`OptimizerResult` +`OptimizerResult`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerState.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerState.md index 82191fb2c6d..363ed8aede2 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerState.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerState.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.OptimizerState --- -# OptimizerState[¶](#optimizerstate "Permalink to this headline") +# OptimizerState -`OptimizerState(x, fun, jac, nfev, njev, nit)` +`OptimizerState(x, fun, jac, nfev, njev, nit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerSupportLevel.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerSupportLevel.md index 56b1c8c8cf8..ae26bc6fc6c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel --- -# OptimizerSupportLevel[¶](#optimizersupportlevel "Permalink to this headline") +# OptimizerSupportLevel -`OptimizerSupportLevel(value)` +`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.POWELL.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.POWELL.md index 088aa44cea6..b18066d10e8 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.POWELL.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.POWELL --- -# POWELL[¶](#powell "Permalink to this headline") +# POWELL -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/powell.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.P_BFGS.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.P_BFGS.md index 0eb4547931f..c3711e8b04f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.P_BFGS.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.P_BFGS.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.P_BFGS --- -# P\_BFGS[¶](#p-bfgs "Permalink to this headline") +# P\_BFGS -`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` +`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") @@ -67,7 +67,7 @@ grad -`P_BFGS.minimize(fun, x0, jac=None, bounds=None)` +`P_BFGS.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/p_bfgs.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.QNSPSA.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.QNSPSA.md index d35615cdb90..6af65beca6c 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.QNSPSA.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.QNSPSA --- -# QNSPSA[¶](#qnspsa "Permalink to this headline") +# QNSPSA -`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` +`QNSPSA(fidelity, maxiter=100, blocking=True, allowed_increase=None, learning_rate=None, perturbation=None, resamplings=1, perturbation_dims=None, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/qnspsa.py "view source code") Bases: [`qiskit.algorithms.optimizers.spsa.SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.spsa.SPSA") @@ -154,7 +154,7 @@ Estimate the standard deviation of the loss function. -`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None, *, sampler=None)` +`static QNSPSA.get_fidelity(circuit, backend=None, expectation=None, *, sampler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/qnspsa.py "view source code") Get a function to compute the fidelity of `circuit` with itself. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SLSQP.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SLSQP.md index 4c03a17c6f3..a407ac6e76b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SLSQP.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.SLSQP --- -# SLSQP[¶](#slsqp "Permalink to this headline") +# SLSQP -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SNOBFIT.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SNOBFIT.md index 59891ad5f7a..764a5be40db 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SNOBFIT.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.SNOBFIT --- -# SNOBFIT[¶](#snobfit "Permalink to this headline") +# SNOBFIT -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -38,7 +38,7 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl -`SNOBFIT.get_support_level()` +`SNOBFIT.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") Returns support level dictionary. @@ -69,7 +69,7 @@ grad -`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)` +`SNOBFIT.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/snobfit.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SPSA.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SPSA.md index 35fe4149e9f..ef6e5d72354 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SPSA.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.SPSA --- -# SPSA[¶](#spsa "Permalink to this headline") +# SPSA -`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)` +`SPSA(maxiter=100, blocking=False, allowed_increase=None, trust_region=False, learning_rate=None, perturbation=None, last_avg=1, resamplings=1, perturbation_dims=None, second_order=False, regularization=None, hessian_delay=0, lse_solver=None, initial_hessian=None, callback=None, termination_checker=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -134,7 +134,7 @@ print(f'SPSA completed after {niter} iterations') -`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)` +`static SPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. @@ -170,7 +170,7 @@ tuple(generator, generator) -`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)` +`static SPSA.estimate_stddev(loss, initial_point, avg=25, max_evals_grouped=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Estimate the standard deviation of the loss function. @@ -182,7 +182,7 @@ Estimate the standard deviation of the loss function. -`SPSA.get_support_level()` +`SPSA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Get the support level dictionary. @@ -213,7 +213,7 @@ grad -`SPSA.minimize(fun, x0, jac=None, bounds=None)` +`SPSA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Minimize the scalar function. @@ -236,7 +236,7 @@ The result of the optimization, containing e.g. the result as attribute `x`. -`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` +`SPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/spsa.py "view source code") Perform optimization. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SciPyOptimizer.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SciPyOptimizer.md index 69abb7c844a..6ee56a70440 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer --- -# SciPyOptimizer[¶](#scipyoptimizer "Permalink to this headline") +# SciPyOptimizer -`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` +`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -31,7 +31,7 @@ For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/ -`SciPyOptimizer.get_support_level()` +`SciPyOptimizer.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Return support level dictionary @@ -62,7 +62,7 @@ grad -`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)` +`SciPyOptimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SteppableOptimizer.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SteppableOptimizer.md index 5375d3435ed..6d682a8fcf8 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SteppableOptimizer.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.SteppableOptimizer.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.SteppableOptimizer --- -# SteppableOptimizer[¶](#steppableoptimizer "Permalink to this headline") +# SteppableOptimizer -`SteppableOptimizer(maxiter=100)` +`SteppableOptimizer(maxiter=100)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -77,7 +77,7 @@ To see other libraries that use this interface one can visit: [https://optuna.re -`SteppableOptimizer.ask()` +`SteppableOptimizer.ask()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Ask the optimizer for a set of points to evaluate. @@ -95,7 +95,7 @@ An object containing the data needed to make the funciton evaluation to advance -`SteppableOptimizer.continue_condition()` +`SteppableOptimizer.continue_condition()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Condition that indicates the optimization process should continue. @@ -111,7 +111,7 @@ Condition that indicates the optimization process should continue. -`abstract SteppableOptimizer.create_result()` +`abstract SteppableOptimizer.create_result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Returns the result of the optimization. @@ -129,7 +129,7 @@ The result of the optimization process. -`abstract SteppableOptimizer.evaluate(ask_data)` +`abstract SteppableOptimizer.evaluate(ask_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Evaluates the function according to the instructions contained in `ask_data`. @@ -182,7 +182,7 @@ grad -`SteppableOptimizer.minimize(fun, x0, jac=None, bounds=None)` +`SteppableOptimizer.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Minimizes the function. @@ -237,7 +237,7 @@ The options dictionary may be used internally by a given optimizer to pass addit -`abstract SteppableOptimizer.start(fun, x0, jac=None, bounds=None)` +`abstract SteppableOptimizer.start(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Populates the state of the optimizer with the data provided and sets all the counters to 0. @@ -256,7 +256,7 @@ Populates the state of the optimizer with the data provided and sets all the cou -`SteppableOptimizer.step()` +`SteppableOptimizer.step()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Performs one step in the optimization process. @@ -270,7 +270,7 @@ This method composes [`ask()`](qiskit.algorithms.optimizers.SteppableOptimizer#a -`SteppableOptimizer.tell(ask_data, tell_data)` +`SteppableOptimizer.tell(ask_data, tell_data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Updates the optimization state using the results of the function evaluation. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TNC.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TNC.md index c76c717641e..75cfef2dfa7 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TNC.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.TNC --- -# TNC[¶](#tnc "Permalink to this headline") +# TNC -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: [`qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer") diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TellData.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TellData.md index ea728d0aa61..ac914eef91d 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TellData.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.TellData.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.TellData --- -# TellData[¶](#telldata "Permalink to this headline") +# TellData -`TellData(eval_fun=None, eval_jac=None)` +`TellData(eval_fun=None, eval_jac=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/steppable_optimizer.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.UMDA.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.UMDA.md index b7c3d7cd539..d1e1964fe51 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.UMDA.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.UMDA.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.UMDA --- -# UMDA[¶](#umda "Permalink to this headline") +# UMDA -`UMDA(maxiter=100, size_gen=20, alpha=0.5)` +`UMDA(maxiter=100, size_gen=20, alpha=0.5)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") Bases: [`qiskit.algorithms.optimizers.optimizer.Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.optimizer.Optimizer") @@ -89,7 +89,7 @@ result = vqe.compute_minimum_eigenvalue(operator=qubit_op) -`UMDA.get_support_level()` +`UMDA.get_support_level()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") Get the support level dictionary. @@ -120,7 +120,7 @@ grad -`UMDA.minimize(fun, x0, jac=None, bounds=None)` +`UMDA.minimize(fun, x0, jac=None, bounds=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/umda.py "view source code") Minimize the scalar function. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.md index 4c232795fcf..4f7358a6dd6 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.md @@ -1,8 +1,8 @@ -# qiskit.algorithms.optimizers[¶](#module-qiskit.algorithms.optimizers "Permalink to this headline") +# qiskit.algorithms.optimizers -## Optimizers ([`qiskit.algorithms.optimizers`](#module-qiskit.algorithms.optimizers "qiskit.algorithms.optimizers"))[¶](#optimizers-qiskit-algorithms-optimizers "Permalink to this headline") +## Optimizers ([`qiskit.algorithms.optimizers`](#module-qiskit.algorithms.optimizers "qiskit.algorithms.optimizers")) It contains a variety of classical optimizers for use by quantum variational algorithms, such as [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE"). Logically, these optimizers can be divided into two categories: @@ -14,7 +14,7 @@ Given an optimization problem, a **local optimizer** is a function that attempts Given an optimization problem, a **global optimizer** is a function that attempts to find an optimal value among all possible solutions. -## Optimizer Base Class[¶](#optimizer-base-class "Permalink to this headline") +## Optimizer Base Class | | | | ---------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | @@ -23,7 +23,7 @@ Given an optimization problem, a **global optimizer** is a function that attempt | [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.Optimizer") | Base class for optimization algorithm. | | [`Minimizer`](qiskit.algorithms.optimizers.Minimizer "qiskit.algorithms.optimizers.Minimizer") | Callable Protocol for minimizer. | -## Steppable Optimizer Base Class[¶](#steppable-optimizer-base-class "Permalink to this headline") +## Steppable Optimizer Base Class | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | @@ -36,7 +36,7 @@ Given an optimization problem, a **global optimizer** is a function that attempt | [`TellData`](qiskit.algorithms.optimizers.TellData "qiskit.algorithms.optimizers.TellData") | Base class for argument type of [`tell()`](qiskit.algorithms.optimizers.SteppableOptimizer#tell "qiskit.algorithms.optimizers.SteppableOptimizer.tell"). | | [`OptimizerState`](qiskit.algorithms.optimizers.OptimizerState "qiskit.algorithms.optimizers.OptimizerState") | Base class representing the state of the optimizer. | -## Local Optimizers[¶](#local-optimizers "Permalink to this headline") +## Local Optimizers | | | | ------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | @@ -67,7 +67,7 @@ Qiskit also provides the following optimizers, which are built-out using the opt | [`IMFIL`](qiskit.algorithms.optimizers.IMFIL "qiskit.algorithms.optimizers.IMFIL") | IMplicit FILtering algorithm. | | [`SNOBFIT`](qiskit.algorithms.optimizers.SNOBFIT "qiskit.algorithms.optimizers.SNOBFIT") | Stable Noisy Optimization by Branch and FIT algorithm. | -## Global Optimizers[¶](#global-optimizers "Permalink to this headline") +## Global Optimizers The global optimizers here all use NLopt for their core function and can only be used if their dependent NLopt package is manually installed. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md index 075395d6ab8..99399f21d71 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.LearningRate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.optimizers.optimizer_utils.LearningRate --- -# LearningRate[¶](#learningrate "Permalink to this headline") +# LearningRate -`LearningRate(learning_rate)` +`LearningRate(learning_rate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Bases: `Generator` @@ -34,7 +34,7 @@ Raise GeneratorExit inside generator. -`LearningRate.send(value)` +`LearningRate.send(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Send a value into the generator. Return next yielded value or raise StopIteration. @@ -42,7 +42,7 @@ Send a value into the generator. Return next yielded value or raise StopIteratio -`LearningRate.throw(typ, val=None, tb=None)` +`LearningRate.throw(typ, val=None, tb=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/optimizers/optimizer_utils/learning_rate.py "view source code") Raise an exception in the generator. Return next yielded value or raise StopIteration. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.md b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.md index 1bc196c17b1..e0bb9c1fc0b 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.optimizers.optimizer_utils.md @@ -1,10 +1,10 @@ -# qiskit.algorithms.optimizers.optimizer\_utils[¶](#module-qiskit.algorithms.optimizers.optimizer_utils "Permalink to this headline") +# qiskit.algorithms.optimizers.optimizer\_utils Utils for optimizers -## Optimizer Utils ([`qiskit.algorithms.optimizers.optimizer_utils`](#module-qiskit.algorithms.optimizers.optimizer_utils "qiskit.algorithms.optimizers.optimizer_utils"))[¶](#optimizer-utils-qiskit-algorithms-optimizers-optimizer-utils "Permalink to this headline") +## Optimizer Utils ([`qiskit.algorithms.optimizers.optimizer_utils`](#module-qiskit.algorithms.optimizers.optimizer_utils "qiskit.algorithms.optimizers.optimizer_utils")) | | | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.BaseStateFidelity.md b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.BaseStateFidelity.md index ee29c55e462..bbd9988735a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.BaseStateFidelity.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.BaseStateFidelity.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.state_fidelities.BaseStateFidelity --- -# BaseStateFidelity[¶](#basestatefidelity "Permalink to this headline") +# BaseStateFidelity -`BaseStateFidelity` +`BaseStateFidelity`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Bases: `abc.ABC` @@ -28,7 +28,7 @@ where $x$ and $y$ are optional parametrizations of the states $\psi$ and $\phi$ -`abstract BaseStateFidelity.create_fidelity_circuit(circuit_1, circuit_2)` +`abstract BaseStateFidelity.create_fidelity_circuit(circuit_1, circuit_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Implementation-dependent method to create a fidelity circuit from 2 circuit inputs. @@ -49,7 +49,7 @@ The fidelity quantum circuit corresponding to `circuit_1` and `circuit_2`. -`BaseStateFidelity.run(circuits_1, circuits_2, values_1=None, values_2=None, **options)` +`BaseStateFidelity.run(circuits_1, circuits_2, values_1=None, values_2=None, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/base_state_fidelity.py "view source code") Runs asynchronously the state overlap (fidelity) calculation between two (parametrized) circuits (first and second) for a specific set of parameter values (first and second). This calculation depends on the particular fidelity method implementation. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.ComputeUncompute.md b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.ComputeUncompute.md index 8086df5be89..f10a6de0474 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.ComputeUncompute.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.ComputeUncompute.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.state_fidelities.ComputeUncompute --- -# ComputeUncompute[¶](#computeuncompute "Permalink to this headline") +# ComputeUncompute -`ComputeUncompute(sampler, options=None)` +`ComputeUncompute(sampler, options=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Bases: [`qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.base_state_fidelity.BaseStateFidelity") @@ -39,7 +39,7 @@ where $x$ and $y$ are optional parametrizations of the states $\psi$ and $\phi$ -`ComputeUncompute.create_fidelity_circuit(circuit_1, circuit_2)` +`ComputeUncompute.create_fidelity_circuit(circuit_1, circuit_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Combines `circuit_1` and `circuit_2` to create the fidelity circuit following the compute-uncompute method. @@ -80,7 +80,7 @@ Primitive job for the fidelity calculation. The job’s result is an instance of -`ComputeUncompute.update_default_options(**options)` +`ComputeUncompute.update_default_options(**options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/compute_uncompute.py "view source code") Update the fidelity’s default options setting. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.StateFidelityResult.md b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.StateFidelityResult.md index c417060ec3c..ae599eaaa77 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.StateFidelityResult.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.StateFidelityResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.state_fidelities.StateFidelityResult --- -# StateFidelityResult[¶](#statefidelityresult "Permalink to this headline") +# StateFidelityResult -`StateFidelityResult(fidelities, raw_fidelities, metadata, options)` +`StateFidelityResult(fidelities, raw_fidelities, metadata, options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/state_fidelities/state_fidelity_result.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.md b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.md index 6b6c599a989..4e8e2b3fccd 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.state_fidelities.md @@ -1,17 +1,17 @@ -# qiskit.algorithms.state\_fidelities[¶](#module-qiskit.algorithms.state_fidelities "Permalink to this headline") +# qiskit.algorithms.state\_fidelities -## State Fidelity Interfaces ([`qiskit.algorithms.state_fidelities`](#module-qiskit.algorithms.state_fidelities "qiskit.algorithms.state_fidelities"))[¶](#state-fidelity-interfaces-qiskit-algorithms-state-fidelities "Permalink to this headline") +## State Fidelity Interfaces ([`qiskit.algorithms.state_fidelities`](#module-qiskit.algorithms.state_fidelities "qiskit.algorithms.state_fidelities")) -### State Fidelities[¶](#state-fidelities "Permalink to this headline") +### State Fidelities | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`BaseStateFidelity`](qiskit.algorithms.state_fidelities.BaseStateFidelity "qiskit.algorithms.state_fidelities.BaseStateFidelity")() | An interface to calculate state fidelities (state overlaps) for pairs of (parametrized) quantum circuits. | | [`ComputeUncompute`](qiskit.algorithms.state_fidelities.ComputeUncompute "qiskit.algorithms.state_fidelities.ComputeUncompute")(sampler\[, options]) | This class leverages the sampler primitive to calculate the state fidelity of two quantum circuits following the compute-uncompute method (see \[1] for further reference). | -### Results[¶](#results "Permalink to this headline") +### Results > | | | > | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md index a0eeb776495..999ba242b3f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.time_evolvers.trotterization.TrotterQRTE --- -# TrotterQRTE[¶](#trotterqrte "Permalink to this headline") +# TrotterQRTE -`TrotterQRTE(product_formula=None, estimator=None)` +`TrotterQRTE(product_formula=None, estimator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver`](qiskit.algorithms.RealTimeEvolver "qiskit.algorithms.time_evolvers.real_time_evolver.RealTimeEvolver") @@ -47,7 +47,7 @@ evolved_state = trotter_qrte.evolve(evolution_problem).evolved_state -`TrotterQRTE.evolve(evolution_problem)` +`TrotterQRTE.evolve(evolution_problem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Evolves a quantum state for a given time using the Trotterization method based on a product formula provided. The result is provided in the form of a quantum circuit. If auxiliary operators are included in the `evolution_problem`, they are evaluated on an evolved state using an estimator primitive provided. @@ -78,7 +78,7 @@ Evolution result that includes an evolved state as a quantum circuit and, option -`classmethod TrotterQRTE.supports_aux_operators()` +`classmethod TrotterQRTE.supports_aux_operators()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/trotterization/trotter_qrte.py "view source code") Whether computing the expectation value of auxiliary operators is supported. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.md b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.md index d1ac4fddd6f..8f7eab51946 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.trotterization.md @@ -1,10 +1,10 @@ -# qiskit.algorithms.time\_evolvers.trotterization[¶](#module-qiskit.algorithms.time_evolvers.trotterization "Permalink to this headline") +# qiskit.algorithms.time\_evolvers.trotterization This package contains Trotterization-based Quantum Real Time Evolution algorithm. It is compliant with the new Quantum Time Evolution Framework and makes use of `qiskit.synthesis.evolution.ProductFormula` and [`PauliEvolutionGate`](qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate") implementations. -## Trotterization-based Quantum Real Time Evolution[¶](#trotterization-based-quantum-real-time-evolution "Permalink to this headline") +## Trotterization-based Quantum Real Time Evolution | | | | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md index 25ff5517504..ea3308b2971 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.time_evolvers.variational.ForwardEulerSolver --- -# ForwardEulerSolver[¶](#forwardeulersolver "Permalink to this headline") +# ForwardEulerSolver -`ForwardEulerSolver(function, t0, y0, t_bound, vectorized=False, support_complex=False, num_t_steps=15)` +`ForwardEulerSolver(function, t0, y0, t_bound, vectorized=False, support_complex=False, num_t_steps=15)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/solvers/ode/forward_euler_solver.py "view source code") Bases: `scipy.integrate._ivp.base.OdeSolver` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md index 01b24e54680..a5b45defcee 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple --- -# ImaginaryMcLachlanPrinciple[¶](#imaginarymclachlanprinciple "Permalink to this headline") +# ImaginaryMcLachlanPrinciple -`ImaginaryMcLachlanPrinciple(qgt=None, gradient=None)` +`ImaginaryMcLachlanPrinciple(qgt=None, gradient=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.variational.variational_principles.imaginary_variational_principle.ImaginaryVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.imaginary_variational_principle.ImaginaryVariationalPrinciple") @@ -31,7 +31,7 @@ Class for an Imaginary McLachlan’s Variational Principle. It aims to minimize -`ImaginaryMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)` +`ImaginaryMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_mc_lachlan_principle.py "view source code") Calculates an evolution gradient according to the rules of this variational principle. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md index ef6766219f6..6cc04edc73a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.time_evolvers.variational.ImaginaryVariationalPrinciple --- -# ImaginaryVariationalPrinciple[¶](#imaginaryvariationalprinciple "Permalink to this headline") +# ImaginaryVariationalPrinciple -`ImaginaryVariationalPrinciple(qgt, gradient)` +`ImaginaryVariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/imaginary_variational_principle.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), `abc.ABC` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md index 125d80bfead..7ad673b1f5a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple --- -# RealMcLachlanPrinciple[¶](#realmclachlanprinciple "Permalink to this headline") +# RealMcLachlanPrinciple -`RealMcLachlanPrinciple(qgt=None, gradient=None)` +`RealMcLachlanPrinciple(qgt=None, gradient=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.variational.variational_principles.real_variational_principle.RealVariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.real_variational_principle.RealVariationalPrinciple") @@ -31,7 +31,7 @@ Class for a Real McLachlan’s Variational Principle. It aims to minimize the di -`RealMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)` +`RealMcLachlanPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_mc_lachlan_principle.py "view source code") Calculates an evolution gradient according to the rules of this variational principle. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md index 6d63d523b26..47d8c8abc79 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.time_evolvers.variational.RealVariationalPrinciple --- -# RealVariationalPrinciple[¶](#realvariationalprinciple "Permalink to this headline") +# RealVariationalPrinciple -`RealVariationalPrinciple(qgt, gradient)` +`RealVariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/real_variational_principle.py "view source code") Bases: [`qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple`](qiskit.algorithms.time_evolvers.variational.VariationalPrinciple "qiskit.algorithms.time_evolvers.variational.variational_principles.variational_principle.VariationalPrinciple"), `abc.ABC` diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md index 236a7d38107..040fe82af2f 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.VariationalPrinciple.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.algorithms.time_evolvers.variational.VariationalPrinciple --- -# VariationalPrinciple[¶](#variationalprinciple "Permalink to this headline") +# VariationalPrinciple -`VariationalPrinciple(qgt, gradient)` +`VariationalPrinciple(qgt, gradient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") Bases: `abc.ABC` @@ -47,7 +47,7 @@ Instance of a class used to compute the state gradient. -`abstract VariationalPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)` +`abstract VariationalPrinciple.evolution_gradient(hamiltonian, ansatz, param_values, gradient_params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") Calculates an evolution gradient according to the rules of this variational principle. @@ -66,7 +66,7 @@ An evolution gradient. -`VariationalPrinciple.metric_tensor(ansatz, param_values)` +`VariationalPrinciple.metric_tensor(ansatz, param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/algorithms/time_evolvers/variational/variational_principles/variational_principle.py "view source code") Calculates a metric tensor according to the rules of this variational principle. diff --git a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.md b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.md index 2d7e6f3c75a..e99f2e4bf0a 100644 --- a/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.md +++ b/docs/api/qiskit/0.41/qiskit.algorithms.time_evolvers.variational.md @@ -1,8 +1,8 @@ -# qiskit.algorithms.time\_evolvers.variational[¶](#module-qiskit.algorithms.time_evolvers.variational "Permalink to this headline") +# qiskit.algorithms.time\_evolvers.variational -## Variational Quantum Time Evolutions ([`qiskit.algorithms.time_evolvers.variational`](#module-qiskit.algorithms.time_evolvers.variational "qiskit.algorithms.time_evolvers.variational"))[¶](#variational-quantum-time-evolutions-qiskit-algorithms-time-evolvers-variational "Permalink to this headline") +## Variational Quantum Time Evolutions ([`qiskit.algorithms.time_evolvers.variational`](#module-qiskit.algorithms.time_evolvers.variational "qiskit.algorithms.time_evolvers.variational")) Algorithms for performing Variational Quantum Time Evolution of quantum states, which can be tailored to near-term devices. `VarQTE` base class exposes an interface, compliant with the Quantum Time Evolution Framework in Qiskit Terra, that is implemented by [`VarQRTE`](qiskit.algorithms.VarQRTE "qiskit.algorithms.VarQRTE") and [`VarQITE`](qiskit.algorithms.VarQITE "qiskit.algorithms.VarQITE") classes for real and imaginary time evolution respectively. The variational approach is taken according to a variational principle chosen by a user. @@ -38,7 +38,7 @@ var_qite = VarQITE(ansatz, var_principle, init_param_values) evolution_result = var_qite.evolve(evolution_problem) ``` -### Variational Principles[¶](#variational-principles "Permalink to this headline") +### Variational Principles With variational principles we can project time evolution of a quantum state onto the parameters of a model, in our case a variational quantum circuit. @@ -52,7 +52,7 @@ They can be divided into two categories: Variational Quantum \_Real\_ Time Evolu | [`RealMcLachlanPrinciple`](qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple "qiskit.algorithms.time_evolvers.variational.RealMcLachlanPrinciple")(\[qgt, gradient]) | Class for a Real McLachlan's Variational Principle. | | [`ImaginaryMcLachlanPrinciple`](qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple "qiskit.algorithms.time_evolvers.variational.ImaginaryMcLachlanPrinciple")(\[qgt, gradient]) | Class for an Imaginary McLachlan's Variational Principle. | -### ODE solvers[¶](#ode-solvers "Permalink to this headline") +### ODE solvers ODE solvers that implement the SciPy ODE Solver interface. The Forward Euler Solver is a preferred choice in the presence of noise. One might also use solvers provided by SciPy directly, e.g. RK45. diff --git a/docs/api/qiskit/0.41/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.41/qiskit.assembler.RunConfig.md index 370b92b0661..4f87ece860a 100644 --- a/docs/api/qiskit/0.41/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.41/qiskit.assembler.RunConfig.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.assembler.RunConfig --- -# RunConfig[¶](#runconfig "Permalink to this headline") +# RunConfig -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") Bases: `types.SimpleNamespace` @@ -83,7 +83,7 @@ Initialize a RunConfig object -`classmethod RunConfig.from_dict(data)` +`classmethod RunConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") Create a new RunConfig object from a dictionary. @@ -103,7 +103,7 @@ The RunConfig from the input dictionary. -`RunConfig.to_dict()` +`RunConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/run_config.py "view source code") Return a dictionary format representation of the RunConfig diff --git a/docs/api/qiskit/0.41/qiskit.assembler.assemble_circuits.md b/docs/api/qiskit/0.41/qiskit.assembler.assemble_circuits.md index 9b62b83861d..bb7ca228856 100644 --- a/docs/api/qiskit/0.41/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.41/qiskit.assembler.assemble_circuits.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.assembler.assemble_circuits --- -# qiskit.assembler.assemble\_circuits[¶](#qiskit-assembler-assemble-circuits "Permalink to this headline") +# qiskit.assembler.assemble\_circuits -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.41/qiskit.assembler.assemble_schedules.md b/docs/api/qiskit/0.41/qiskit.assembler.assemble_schedules.md index 80b7de79e2c..aaeec1fac8b 100644 --- a/docs/api/qiskit/0.41/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.41/qiskit.assembler.assemble_schedules.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.assembler.assemble_schedules --- -# qiskit.assembler.assemble\_schedules[¶](#qiskit-assembler-assemble-schedules "Permalink to this headline") +# qiskit.assembler.assemble\_schedules -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. diff --git a/docs/api/qiskit/0.41/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.41/qiskit.assembler.disassemble.md index a7db65ef095..bf93132d85d 100644 --- a/docs/api/qiskit/0.41/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.41/qiskit.assembler.disassemble.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.assembler.disassemble --- -# qiskit.assembler.disassemble[¶](#qiskit-assembler-disassemble "Permalink to this headline") +# qiskit.assembler.disassemble -`disassemble(qobj)` +`disassemble(qobj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/assembler/disassemble.py "view source code") Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.41/qiskit.circuit.AncillaQubit.md index 8968db98972..8fa12e98d6a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.AncillaQubit.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.AncillaQubit --- -# AncillaQubit[¶](#ancillaqubit "Permalink to this headline") +# AncillaQubit -`AncillaQubit(register=None, index=None)` +`AncillaQubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Bases: [`qiskit.circuit.quantumregister.Qubit`](qiskit.circuit.Qubit "qiskit.circuit.quantumregister.Qubit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.41/qiskit.circuit.AncillaRegister.md index 529404d28db..416778a78f5 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.AncillaRegister.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.AncillaRegister --- -# AncillaRegister[¶](#ancillaregister "Permalink to this headline") +# AncillaRegister -`AncillaRegister(size=None, name=None, bits=None)` +`AncillaRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Bases: [`qiskit.circuit.quantumregister.QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.quantumregister.QuantumRegister") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.BreakLoopOp.md b/docs/api/qiskit/0.41/qiskit.circuit.BreakLoopOp.md index 77d0162872a..d7fecec8d82 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.BreakLoopOp.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.BreakLoopOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.BreakLoopOp --- -# BreakLoopOp[¶](#breakloopop "Permalink to this headline") +# BreakLoopOp -`BreakLoopOp(num_qubits, num_clbits, label=None)` +`BreakLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/break_loop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.CircuitInstruction.md b/docs/api/qiskit/0.41/qiskit.circuit.CircuitInstruction.md index d63d97be02e..11f7c25eb70 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.CircuitInstruction.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.CircuitInstruction.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.CircuitInstruction --- -# CircuitInstruction[¶](#circuitinstruction "Permalink to this headline") +# CircuitInstruction -`CircuitInstruction(operation, qubits=(), clbits=())` +`CircuitInstruction(operation, qubits=(), clbits=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ A single instruction in a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qisk -`CircuitInstruction.copy()` +`CircuitInstruction.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") Return a shallow copy of the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction"). @@ -38,7 +38,7 @@ Return a shallow copy of the [`CircuitInstruction`](qiskit.circuit.CircuitInstru -`CircuitInstruction.replace(operation=None, qubits=None, clbits=None)` +`CircuitInstruction.replace(operation=None, qubits=None, clbits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuitdata.py "view source code") Return a new [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction") with the given fields replaced. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.41/qiskit.circuit.ClassicalRegister.md index f179686286b..ef681a84289 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.ClassicalRegister.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.ClassicalRegister --- -# ClassicalRegister[¶](#classicalregister "Permalink to this headline") +# ClassicalRegister -`ClassicalRegister(size=None, name=None, bits=None)` +`ClassicalRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -48,7 +48,7 @@ Find the index of the provided bit within this register. -`ClassicalRegister.qasm()` +`ClassicalRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.41/qiskit.circuit.Clbit.md index 1c4cad0a30f..43a47cbe1b3 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.Clbit.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.Clbit --- -# Clbit[¶](#clbit "Permalink to this headline") +# Clbit -`Clbit(register=None, index=None)` +`Clbit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ContinueLoopOp.md b/docs/api/qiskit/0.41/qiskit.circuit.ContinueLoopOp.md index 2cc929b08bd..804ed3e332b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ContinueLoopOp.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.ContinueLoopOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.ContinueLoopOp --- -# ContinueLoopOp[¶](#continueloopop "Permalink to this headline") +# ContinueLoopOp -`ContinueLoopOp(num_qubits, num_clbits, label=None)` +`ContinueLoopOp(num_qubits, num_clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/continue_loop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ControlFlowOp.md b/docs/api/qiskit/0.41/qiskit.circuit.ControlFlowOp.md index fa7bfc7a745..c3a59f63e36 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ControlFlowOp.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.ControlFlowOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.ControlFlowOp --- -# ControlFlowOp[¶](#controlflowop "Permalink to this headline") +# ControlFlowOp -`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` +`ControlFlowOp(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/control_flow.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction"), `abc.ABC` @@ -176,7 +176,7 @@ Containing the definition. -`abstract ControlFlowOp.replace_blocks(blocks)` +`abstract ControlFlowOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/control_flow.py "view source code") Replace blocks and return new instruction. :type blocks: `Iterable`\[[`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")] :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.41/qiskit.circuit.ControlledGate.md index 34f356bacb7..a4531673e10 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.ControlledGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.ControlledGate --- -# ControlledGate[¶](#controlledgate "Permalink to this headline") +# ControlledGate -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlledgate.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -206,7 +206,7 @@ updated if it was provided -`ControlledGate.inverse()` +`ControlledGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlledgate.py "view source code") Invert this gate by calling inverse on the base gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Delay.md b/docs/api/qiskit/0.41/qiskit.circuit.Delay.md index 3e97a69d53a..da2e5d5f610 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.Delay.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.Delay --- -# Delay[¶](#delay "Permalink to this headline") +# Delay -`Delay(duration, unit='dt')` +`Delay(duration, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Delay.broadcast_arguments(qargs, cargs)` +`Delay.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Validation of the arguments. @@ -61,7 +61,7 @@ Validation of the arguments. -`Delay.c_if(classical, val)` +`Delay.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -95,7 +95,7 @@ updated if it was provided -`Delay.inverse()` +`Delay.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Special case. Return self. @@ -185,7 +185,7 @@ bool -`Delay.to_matrix()` +`Delay.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Return a Numpy.array for the unitary matrix. This has been added to enable simulation without making delay a full Gate type. @@ -201,7 +201,7 @@ np.ndarray -`Delay.validate_parameter(parameter)` +`Delay.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/delay.py "view source code") Delay parameter (i.e. duration) must be int, float or ParameterExpression. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.41/qiskit.circuit.EquivalenceLibrary.md index 0f36012f383..a3d0b4660a3 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.EquivalenceLibrary.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.EquivalenceLibrary --- -# EquivalenceLibrary[¶](#equivalencelibrary "Permalink to this headline") +# EquivalenceLibrary -`EquivalenceLibrary(*, base=None)` +`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Create a new equivalence library. -`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)` +`EquivalenceLibrary.add_equivalence(gate, equivalent_circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Add a new equivalence to the library. Future queries for the Gate will include the given circuit, in addition to all existing equivalences (including those from base). @@ -43,7 +43,7 @@ Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.par -`EquivalenceLibrary.draw(filename=None)` +`EquivalenceLibrary.draw(filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Draws the equivalence relations available in the library. @@ -69,7 +69,7 @@ PIL.Image or IPython.display.SVG -`EquivalenceLibrary.get_entry(gate)` +`EquivalenceLibrary.get_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate. @@ -95,7 +95,7 @@ List\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCirc -`EquivalenceLibrary.has_entry(gate)` +`EquivalenceLibrary.has_entry(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Check if a library contains any decompositions for gate. @@ -117,7 +117,7 @@ Bool -`EquivalenceLibrary.keys()` +`EquivalenceLibrary.keys()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Return list of keys to key to node index map. @@ -133,7 +133,7 @@ List -`EquivalenceLibrary.node_index(key)` +`EquivalenceLibrary.node_index(key)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Return node index for a given key. @@ -153,7 +153,7 @@ Int -`EquivalenceLibrary.set_entry(gate, entry)` +`EquivalenceLibrary.set_entry(gate, entry)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/equivalence.py "view source code") Set the equivalence record for a Gate. Future queries for the Gate will return only the circuits provided. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ForLoopOp.md b/docs/api/qiskit/0.41/qiskit.circuit.ForLoopOp.md index 83e7da01006..929aa14ed46 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ForLoopOp.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.ForLoopOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.ForLoopOp --- -# ForLoopOp[¶](#forloopop "Permalink to this headline") +# ForLoopOp -`ForLoopOp(indexset, loop_parameter, body, label=None)` +`ForLoopOp(indexset, loop_parameter, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/for_loop.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -197,7 +197,7 @@ Containing the definition. -`ForLoopOp.replace_blocks(blocks)` +`ForLoopOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/for_loop.py "view source code") Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Gate.md b/docs/api/qiskit/0.41/qiskit.circuit.Gate.md index 8b8511cecff..080a24edfc7 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.Gate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.Gate --- -# Gate[¶](#gate "Permalink to this headline") +# Gate -`Gate(name, num_qubits, params, label=None)` +`Gate(name, num_qubits, params, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -47,7 +47,7 @@ Assemble a QasmQobjInstruction -`Gate.broadcast_arguments(qargs, cargs)` +`Gate.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Validation and handling of the arguments and its relationship. @@ -114,7 +114,7 @@ Set a classical equality condition on this instruction between the register or c -`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. @@ -194,7 +194,7 @@ Return True .IFF. instruction is parameterized else False -`Gate.power(exponent)` +`Gate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Creates a unitary gate as gate^exponent. @@ -292,7 +292,7 @@ bool -`Gate.to_matrix()` +`Gate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Return a Numpy.array for the gate unitary matrix. @@ -312,7 +312,7 @@ np.ndarray -`Gate.validate_parameter(parameter)` +`Gate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/gate.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.41/qiskit.circuit.IfElseOp.md b/docs/api/qiskit/0.41/qiskit.circuit.IfElseOp.md index b1de74f79f2..a7d5e571f02 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.IfElseOp.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.IfElseOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.IfElseOp --- -# IfElseOp[¶](#ifelseop "Permalink to this headline") +# IfElseOp -`IfElseOp(condition, true_body, false_body=None, label=None)` +`IfElseOp(condition, true_body, false_body=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -101,7 +101,7 @@ Validation of the arguments. -`IfElseOp.c_if(classical, val)` +`IfElseOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -201,7 +201,7 @@ Containing the definition. -`IfElseOp.replace_blocks(blocks)` +`IfElseOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/if_else.py "view source code") Replace blocks and return new instruction. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.41/qiskit.circuit.Instruction.md index 028a9dae131..de74c5a2202 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.Instruction.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.Instruction --- -# Instruction[¶](#instruction "Permalink to this headline") +# Instruction -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Bases: [`qiskit.circuit.operation.Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") @@ -39,7 +39,7 @@ Create a new instruction. -`Instruction.add_decomposition(decomposition)` +`Instruction.add_decomposition(decomposition)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Add a decomposition of the instruction to the SessionEquivalenceLibrary. @@ -47,7 +47,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Instruction.assemble()` +`Instruction.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Assemble a QasmQobjInstruction @@ -55,7 +55,7 @@ Assemble a QasmQobjInstruction -`Instruction.broadcast_arguments(qargs, cargs)` +`Instruction.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Validation of the arguments. @@ -76,7 +76,7 @@ Validation of the arguments. -`Instruction.c_if(classical, val)` +`Instruction.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -88,7 +88,7 @@ Set a classical equality condition on this instruction between the register or c -`Instruction.copy(name=None)` +`Instruction.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Copy of the instruction. @@ -110,7 +110,7 @@ updated if it was provided -`Instruction.inverse()` +`Instruction.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Invert this instruction. @@ -134,7 +134,7 @@ a fresh instruction for the inverse -`Instruction.is_parameterized()` +`Instruction.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Return True .IFF. instruction is parameterized else False @@ -142,7 +142,7 @@ Return True .IFF. instruction is parameterized else False -`Instruction.qasm()` +`Instruction.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Return a default OpenQASM string for the instruction. @@ -152,7 +152,7 @@ Derived instructions may override this to print in a different format (e.g. meas -`Instruction.repeat(n)` +`Instruction.repeat(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Creates an instruction with gate repeated n amount of times. @@ -176,7 +176,7 @@ Containing the definition. -`Instruction.reverse_ops()` +`Instruction.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") For a composite instruction, reverse the order of sub-instructions. @@ -196,7 +196,7 @@ sub-instructions reversed. -`Instruction.soft_compare(other)` +`Instruction.soft_compare(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account. @@ -216,7 +216,7 @@ bool -`Instruction.validate_parameter(parameter)` +`Instruction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instruction.py "view source code") Instruction parameters has no validation or normalization. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.41/qiskit.circuit.InstructionSet.md index 9520ff2a479..4a26ef8f09f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.InstructionSet.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.InstructionSet --- -# InstructionSet[¶](#instructionset "Permalink to this headline") +# InstructionSet -`InstructionSet(circuit_cregs=None, *, resource_requester=None)` +`InstructionSet(circuit_cregs=None, *, resource_requester=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") Bases: `object` @@ -48,7 +48,7 @@ The context (qargs and cargs that each instruction is attached to) is also store -`InstructionSet.add(instruction, qargs=None, cargs=None)` +`InstructionSet.add(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") Add an instruction and its context (where it is attached). @@ -56,7 +56,7 @@ Add an instruction and its context (where it is attached). -`InstructionSet.c_if(classical, val)` +`InstructionSet.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") Set a classical equality condition on all the instructions in this set between the [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") or [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit") `classical` and value `val`. @@ -107,7 +107,7 @@ qc.draw('mpl') -`InstructionSet.inverse()` +`InstructionSet.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/instructionset.py "view source code") Invert all instructions. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Operation.md b/docs/api/qiskit/0.41/qiskit.circuit.Operation.md index ebb2006e3ee..7e28c49cfd5 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Operation.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.Operation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.Operation --- -# Operation[¶](#operation "Permalink to this headline") +# Operation -`Operation` +`Operation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/operation.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.41/qiskit.circuit.Parameter.md index da4fd46eecc..b4b821cb48a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.Parameter.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.Parameter --- -# Parameter[¶](#parameter "Permalink to this headline") +# Parameter -`Parameter(name)` +`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameter.py "view source code") Bases: [`qiskit.circuit.parameterexpression.ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression") @@ -207,7 +207,7 @@ Sine of a ParameterExpression -`Parameter.subs(parameter_map, allow_unknown_parameters=False)` +`Parameter.subs(parameter_map, allow_unknown_parameters=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameter.py "view source code") Substitute self with the corresponding parameter in `parameter_map`. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.41/qiskit.circuit.ParameterExpression.md index 52a2e5fd433..b7cd30b40f0 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.ParameterExpression.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.ParameterExpression --- -# ParameterExpression[¶](#parameterexpression "Permalink to this headline") +# ParameterExpression -`ParameterExpression(symbol_map, expr)` +`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Not intended to be called directly, but to be instantiated via operations on oth -`ParameterExpression.arccos()` +`ParameterExpression.arccos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Arccos of a ParameterExpression @@ -39,7 +39,7 @@ Arccos of a ParameterExpression -`ParameterExpression.arcsin()` +`ParameterExpression.arcsin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Arcsin of a ParameterExpression @@ -47,7 +47,7 @@ Arcsin of a ParameterExpression -`ParameterExpression.arctan()` +`ParameterExpression.arctan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Arctan of a ParameterExpression @@ -55,7 +55,7 @@ Arctan of a ParameterExpression -`ParameterExpression.assign(parameter, value)` +`ParameterExpression.assign(parameter, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Assign one parameter to a value, which can either be numeric or another parameter expression. @@ -76,7 +76,7 @@ A new expression parameterized by any parameters which were not bound by assignm -`ParameterExpression.bind(parameter_values, allow_unknown_parameters=False)` +`ParameterExpression.bind(parameter_values, allow_unknown_parameters=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Binds the provided set of parameters to their corresponding values. @@ -107,7 +107,7 @@ A new expression parameterized by any parameters which were not bound by paramet -`ParameterExpression.conjugate()` +`ParameterExpression.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Return the conjugate. @@ -119,7 +119,7 @@ Return the conjugate. -`ParameterExpression.cos()` +`ParameterExpression.cos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Cosine of a ParameterExpression @@ -127,7 +127,7 @@ Cosine of a ParameterExpression -`ParameterExpression.exp()` +`ParameterExpression.exp()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Exponential of a ParameterExpression @@ -135,7 +135,7 @@ Exponential of a ParameterExpression -`ParameterExpression.gradient(param)` +`ParameterExpression.gradient(param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Get the derivative of a parameter expression w\.r.t. a specified parameter expression. @@ -155,7 +155,7 @@ ParameterExpression representing the gradient of param\_expr w\.r.t. param or co -`ParameterExpression.is_real()` +`ParameterExpression.is_real()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Return whether the expression is real @@ -163,7 +163,7 @@ Return whether the expression is real -`ParameterExpression.log()` +`ParameterExpression.log()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Logarithm of a ParameterExpression @@ -171,7 +171,7 @@ Logarithm of a ParameterExpression -`ParameterExpression.sin()` +`ParameterExpression.sin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Sine of a ParameterExpression @@ -179,7 +179,7 @@ Sine of a ParameterExpression -`ParameterExpression.subs(parameter_map, allow_unknown_parameters=False)` +`ParameterExpression.subs(parameter_map, allow_unknown_parameters=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Returns a new Expression with replacement Parameters. @@ -206,7 +206,7 @@ A new expression with the specified parameters replaced. -`ParameterExpression.sympify()` +`ParameterExpression.sympify()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Return symbolic expression as a raw Sympy or Symengine object. @@ -220,7 +220,7 @@ Symengine is used preferentially; if both are available, the result will always -`ParameterExpression.tan()` +`ParameterExpression.tan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parameterexpression.py "view source code") Tangent of a ParameterExpression diff --git a/docs/api/qiskit/0.41/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.41/qiskit.circuit.ParameterVector.md index c9ff72eb14f..8ebdbd000e6 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.ParameterVector.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.ParameterVector --- -# ParameterVector[¶](#parametervector "Permalink to this headline") +# ParameterVector -`ParameterVector(name, length=0)` +`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ ParameterVector class to quickly generate lists of parameters. -`ParameterVector.index(value)` +`ParameterVector.index(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") Returns first index of value. @@ -30,7 +30,7 @@ Returns first index of value. -`ParameterVector.resize(length)` +`ParameterVector.resize(length)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/parametervector.py "view source code") Resize the parameter vector. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.41/qiskit.circuit.QuantumCircuit.md index 9363c8926db..002c32f8823 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.QuantumCircuit.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.QuantumCircuit --- -# QuantumCircuit[¶](#quantumcircuit "Permalink to this headline") +# QuantumCircuit -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Bases: `object` @@ -107,7 +107,7 @@ qc.draw('mpl') -`QuantumCircuit.add_bits(bits)` +`QuantumCircuit.add_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Add Bits to the circuit. @@ -119,7 +119,7 @@ Add Bits to the circuit. -`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)` +`QuantumCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -142,7 +142,7 @@ Register a low-level, custom pulse definition for the given gate. -`QuantumCircuit.add_register(*regs)` +`QuantumCircuit.add_register(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Add registers. @@ -154,7 +154,7 @@ Add registers. -`QuantumCircuit.append(instruction, qargs=None, cargs=None)` +`QuantumCircuit.append(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Append one or more instructions to the end of the circuit, modifying the circuit in place. @@ -184,7 +184,7 @@ a handle to the [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit -`QuantumCircuit.assign_parameters(parameters, inplace=False)` +`QuantumCircuit.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Assign parameters to new parameters or values. @@ -264,7 +264,7 @@ Fig. 9 ([`png`](_downloads/e15ada4dc0293578ac577fd7c1da7d3f/qiskit-circuit-Quant -`QuantumCircuit.barrier(*qargs, label=None)` +`QuantumCircuit.barrier(*qargs, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `Barrier`. If qargs is empty, applies to all qubits in the circuit. @@ -285,7 +285,7 @@ handle to the added instructions. -`QuantumCircuit.bind_parameters(values)` +`QuantumCircuit.bind_parameters(values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Assign numeric parameters to values yielding a new circuit. @@ -314,7 +314,7 @@ Copy of self with assignment substitution. -`QuantumCircuit.break_loop()` +`QuantumCircuit.break_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `BreakLoopOp`. @@ -338,7 +338,7 @@ A handle to the instruction created. -`static QuantumCircuit.cast(value, type_)` +`static QuantumCircuit.cast(value, type_)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Best effort to cast value to type. Otherwise, returns the value. @@ -350,7 +350,7 @@ Best effort to cast value to type. Otherwise, returns the value. -`QuantumCircuit.cbit_argument_conversion(clbit_representation)` +`QuantumCircuit.cbit_argument_conversion(clbit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. @@ -370,7 +370,7 @@ List(tuple) -`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)` +`QuantumCircuit.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -395,7 +395,7 @@ A handle to the instructions created. -`QuantumCircuit.ccz(control_qubit1, control_qubit2, target_qubit, label=None, ctrl_state=None)` +`QuantumCircuit.ccz(control_qubit1, control_qubit2, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `CCZGate`. @@ -421,7 +421,7 @@ A handle to the instructions created. -`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)` +`QuantumCircuit.ch(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). @@ -446,7 +446,7 @@ A handle to the instructions created. -`QuantumCircuit.clear()` +`QuantumCircuit.clear()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Clear all instructions in self. @@ -460,7 +460,7 @@ Clearing the circuits will keep the metadata and calibrations. -`classmethod QuantumCircuit.cls_instances()` +`classmethod QuantumCircuit.cls_instances()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the current number of instances of this class, useful for auto naming. @@ -472,7 +472,7 @@ Return the current number of instances of this class, useful for auto naming. -`classmethod QuantumCircuit.cls_prefix()` +`classmethod QuantumCircuit.cls_prefix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the prefix to use for auto naming. @@ -484,7 +484,7 @@ Return the prefix to use for auto naming. -`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)` +`QuantumCircuit.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -513,7 +513,7 @@ A handle to the instructions created. -`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)` +`QuantumCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Compose circuit with `other` circuit or instruction, optionally permuting wires. @@ -569,7 +569,7 @@ lcr_1: 0 ═══════════ lcr_1: 0 -`QuantumCircuit.continue_loop()` +`QuantumCircuit.continue_loop()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `ContinueLoopOp`. @@ -593,7 +593,7 @@ A handle to the instruction created. -`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`QuantumCircuit.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Control this circuit on `num_ctrl_qubits` qubits. @@ -619,7 +619,7 @@ The controlled version of this circuit. -`QuantumCircuit.copy(name=None)` +`QuantumCircuit.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Copy the circuit. @@ -639,7 +639,7 @@ a deepcopy of the current circuit, with the specified name -`QuantumCircuit.copy_empty_like(name=None)` +`QuantumCircuit.copy_empty_like(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return a copy of self with the same structure but empty. @@ -665,7 +665,7 @@ An empty copy of self. -`QuantumCircuit.count_ops()` +`QuantumCircuit.count_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Count each operation kind in the circuit. @@ -681,7 +681,7 @@ OrderedDict -`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` +`QuantumCircuit.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). @@ -707,7 +707,7 @@ A handle to the instructions created. -`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` +`QuantumCircuit.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). @@ -733,7 +733,7 @@ A handle to the instructions created. -`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` +`QuantumCircuit.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). @@ -759,7 +759,7 @@ A handle to the instructions created. -`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` +`QuantumCircuit.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). @@ -785,7 +785,7 @@ A handle to the instructions created. -`QuantumCircuit.cs(control_qubit, target_qubit, label=None, ctrl_state=None)` +`QuantumCircuit.cs(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `CSGate`. @@ -810,7 +810,7 @@ A handle to the instructions created. -`QuantumCircuit.csdg(control_qubit, target_qubit, label=None, ctrl_state=None)` +`QuantumCircuit.csdg(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `CSdgGate`. @@ -835,7 +835,7 @@ A handle to the instructions created. -`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)` +`QuantumCircuit.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -861,7 +861,7 @@ A handle to the instructions created. -`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)` +`QuantumCircuit.csx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). @@ -886,7 +886,7 @@ A handle to the instructions created. -`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)` +`QuantumCircuit.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). @@ -915,7 +915,7 @@ A handle to the instructions created. -`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)` +`QuantumCircuit.cx(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). @@ -940,7 +940,7 @@ A handle to the instructions created. -`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)` +`QuantumCircuit.cy(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). @@ -965,7 +965,7 @@ A handle to the instructions created. -`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)` +`QuantumCircuit.cz(control_qubit, target_qubit, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). @@ -990,7 +990,7 @@ A handle to the instructions created. -`QuantumCircuit.dcx(qubit1, qubit2)` +`QuantumCircuit.dcx(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). @@ -1013,7 +1013,7 @@ A handle to the instructions created. -`QuantumCircuit.decompose(gates_to_decompose=None, reps=1)` +`QuantumCircuit.decompose(gates_to_decompose=None, reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Call a decomposition pass on this circuit, to decompose one level (shallow decompose). @@ -1034,7 +1034,7 @@ a circuit one level decomposed -`QuantumCircuit.delay(duration, qarg=None, unit='dt')` +`QuantumCircuit.delay(duration, qarg=None, unit='dt')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay"). If qarg is None, applies to all qubits. When applying to multiple qubits, delays with the same duration will be created. @@ -1060,7 +1060,7 @@ handle to the added instructions. -`QuantumCircuit.depth(filter_function=>)` +`QuantumCircuit.depth(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return circuit depth (i.e., length of critical path). @@ -1111,7 +1111,7 @@ the diagonal gate which was attached to the circuit. -`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)` +`QuantumCircuit.draw(output=None, scale=None, filename=None, style=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: @@ -1185,7 +1185,7 @@ qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'}) -`QuantumCircuit.ecr(qubit1, qubit2)` +`QuantumCircuit.ecr(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). @@ -1208,7 +1208,7 @@ A handle to the instructions created. -`QuantumCircuit.find_bit(bit)` +`QuantumCircuit.find_bit(bit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Find locations in the circuit which can be used to reference a given `Bit`. @@ -1241,7 +1241,7 @@ The circuit index of an [`AncillaQubit`](qiskit.circuit.AncillaQubit "qiskit.cir -`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext` +`QuantumCircuit.for_loop(indexset: Iterable[int], loop_parameter: Optional[qiskit.circuit.parameter.Parameter], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.for_loop.ForLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") @@ -1298,7 +1298,7 @@ depending on the call signature, either a context manager for creating the for l -`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)` +`QuantumCircuit.fredkin(control_qubit, target_qubit1, target_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). @@ -1326,7 +1326,7 @@ A handle to the instructions created. -`static QuantumCircuit.from_instructions(instructions, *, qubits=(), clbits=(), name=None, global_phase=0, metadata=None)` +`static QuantumCircuit.from_instructions(instructions, *, qubits=(), clbits=(), name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Construct a circuit from an iterable of CircuitInstructions. @@ -1347,7 +1347,7 @@ The quantum circuit. -`static QuantumCircuit.from_qasm_file(path)` +`static QuantumCircuit.from_qasm_file(path)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM file and generate a QuantumCircuit object. @@ -1367,7 +1367,7 @@ The QuantumCircuit object for the input QASM -`static QuantumCircuit.from_qasm_str(qasm_str)` +`static QuantumCircuit.from_qasm_str(qasm_str)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Take in a QASM string and generate a QuantumCircuit object. @@ -1387,7 +1387,7 @@ The QuantumCircuit object for the input QASM -`QuantumCircuit.get_instructions(name)` +`QuantumCircuit.get_instructions(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Get instructions matching name. @@ -1407,7 +1407,7 @@ list(tuple) -`QuantumCircuit.h(qubit)` +`QuantumCircuit.h(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). @@ -1437,7 +1437,7 @@ Apply hamiltonian evolution to qubits. -`QuantumCircuit.has_calibration_for(instr_context)` +`QuantumCircuit.has_calibration_for(instr_context)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return True if the circuit has a calibration defined for the instruction context. In this case, the operation does not need to be translated to the device basis. @@ -1445,7 +1445,7 @@ Return True if the circuit has a calibration defined for the instruction context -`QuantumCircuit.has_register(register)` +`QuantumCircuit.has_register(register)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Test if this circuit has the register r. @@ -1465,7 +1465,7 @@ bool -`QuantumCircuit.i(qubit)` +`QuantumCircuit.i(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1487,7 +1487,7 @@ A handle to the instructions created. -`QuantumCircuit.id(qubit)` +`QuantumCircuit.id(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). @@ -1513,7 +1513,7 @@ A handle to the instructions created. -`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)` +`QuantumCircuit.if_else(condition, true_body, false_body, qubits, clbits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply `IfElseOp`. @@ -1561,7 +1561,7 @@ A handle to the instruction created. -`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext` +`QuantumCircuit.if_test(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], true_body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.if_else.IfContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") @@ -1717,7 +1717,7 @@ q_1: ┤1 ├ -`QuantumCircuit.inverse()` +`QuantumCircuit.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Invert (take adjoint of) this circuit. @@ -1819,7 +1819,7 @@ the isometry is attached to the quantum circuit. -`QuantumCircuit.iswap(qubit1, qubit2)` +`QuantumCircuit.iswap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). @@ -1842,7 +1842,7 @@ A handle to the instructions created. -`QuantumCircuit.mcp(lam, control_qubits, target_qubit)` +`QuantumCircuit.mcp(lam, control_qubits, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). @@ -1928,7 +1928,7 @@ Apply Multiple-Controlled Z rotation gate -`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` +`QuantumCircuit.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -1969,7 +1969,7 @@ A handle to the instructions created. -`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` +`QuantumCircuit.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). @@ -2006,7 +2006,7 @@ A handle to the instructions created. -`QuantumCircuit.measure(qubit, cbit)` +`QuantumCircuit.measure(qubit, cbit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Measure quantum bit into classical bit (tuples). @@ -2031,7 +2031,7 @@ handle to the added instructions. -`QuantumCircuit.measure_active(inplace=True)` +`QuantumCircuit.measure_active(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. @@ -2053,7 +2053,7 @@ Returns circuit with measurements when inplace = False. -`QuantumCircuit.measure_all(inplace=True, add_bits=True)` +`QuantumCircuit.measure_all(inplace=True, add_bits=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Adds measurement to all qubits. @@ -2082,7 +2082,7 @@ Returns circuit with measurements when `inplace=False`. -`QuantumCircuit.ms(theta, qubits)` +`QuantumCircuit.ms(theta, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.generalized_gates.gms.MSGate"). @@ -2105,7 +2105,7 @@ A handle to the instructions created. -`QuantumCircuit.num_connected_components(unitary_only=False)` +`QuantumCircuit.num_connected_components(unitary_only=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") How many non-entangled subcircuits can the circuit be factored to. @@ -2125,7 +2125,7 @@ int -`QuantumCircuit.num_nonlocal_gates()` +`QuantumCircuit.num_nonlocal_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return number of non-local gates (i.e. involving 2+ qubits). @@ -2139,7 +2139,7 @@ Conditional nonlocal gates are also included. -`QuantumCircuit.num_tensor_factors()` +`QuantumCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2155,7 +2155,7 @@ This is here for backwards compatibility, and will be removed in a future releas -`QuantumCircuit.num_unitary_factors()` +`QuantumCircuit.num_unitary_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Computes the number of tensor factors in the unitary (quantum) part of the circuit only. @@ -2167,7 +2167,7 @@ Computes the number of tensor factors in the unitary (quantum) part of the circu -`QuantumCircuit.p(theta, qubit)` +`QuantumCircuit.p(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). @@ -2190,7 +2190,7 @@ A handle to the instructions created. -`QuantumCircuit.pauli(pauli_string, qubits)` +`QuantumCircuit.pauli(pauli_string, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). @@ -2211,7 +2211,7 @@ A handle to the instructions created. -`QuantumCircuit.power(power, matrix_power=False)` +`QuantumCircuit.power(power, matrix_power=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Raise this circuit to the power of `power`. @@ -2337,7 +2337,7 @@ q_1: ┤1 ├ -`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)` +`QuantumCircuit.qasm(formatted=False, filename=None, encoding=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return OpenQASM string. @@ -2364,7 +2364,7 @@ str -`QuantumCircuit.qbit_argument_conversion(qubit_representation)` +`QuantumCircuit.qbit_argument_conversion(qubit_representation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. @@ -2384,7 +2384,7 @@ List([Qubit](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) -`QuantumCircuit.qubit_duration(*qubits)` +`QuantumCircuit.qubit_duration(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2404,7 +2404,7 @@ Return the duration between the first start and last stop time of non-delay inst -`QuantumCircuit.qubit_start_time(*qubits)` +`QuantumCircuit.qubit_start_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2431,7 +2431,7 @@ Return the start time of the first instruction, excluding delays, over the qubit -`QuantumCircuit.qubit_stop_time(*qubits)` +`QuantumCircuit.qubit_stop_time(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. @@ -2458,7 +2458,7 @@ Return the stop time of the last instruction, excluding delays, over the qubits -`QuantumCircuit.r(theta, phi, qubit)` +`QuantumCircuit.r(theta, phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). @@ -2482,7 +2482,7 @@ A handle to the instructions created. -`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)` +`QuantumCircuit.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). @@ -2507,7 +2507,7 @@ A handle to the instructions created. -`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)` +`QuantumCircuit.rccx(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). @@ -2531,7 +2531,7 @@ A handle to the instructions created. -`QuantumCircuit.remove_final_measurements(inplace=True)` +`QuantumCircuit.remove_final_measurements(inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Removes final measurements and barriers on all qubits if they are present. Deletes the classical registers that were used to store the values from these measurements that become idle as a result of this operation, and deletes classical bits that are referenced only by removed registers, or that aren’t referenced at all but have become idle as a result of this operation. @@ -2553,7 +2553,7 @@ Returns the resulting circuit when `inplace=False`, else None. -`QuantumCircuit.repeat(reps)` +`QuantumCircuit.repeat(reps)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Repeat this circuit `reps` times. @@ -2573,7 +2573,7 @@ A circuit containing `reps` repetitions of this circuit. -`QuantumCircuit.reset(qubit)` +`QuantumCircuit.reset(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Reset the quantum bit(s) to their default state. @@ -2593,7 +2593,7 @@ handle to the added instruction. -`QuantumCircuit.reverse_bits()` +`QuantumCircuit.reverse_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return a circuit with the opposite order of wires. @@ -2647,7 +2647,7 @@ a_2: ┤ H ├──■───────────────── -`QuantumCircuit.reverse_ops()` +`QuantumCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Reverse the circuit by reversing the order of instructions. @@ -2687,7 +2687,7 @@ q_1: ┤ RX(1.57) ├───── -`QuantumCircuit.rv(vx, vy, vz, qubit)` +`QuantumCircuit.rv(vx, vy, vz, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). @@ -2714,7 +2714,7 @@ A handle to the instructions created. -`QuantumCircuit.rx(theta, qubit, label=None)` +`QuantumCircuit.rx(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). @@ -2738,7 +2738,7 @@ A handle to the instructions created. -`QuantumCircuit.rxx(theta, qubit1, qubit2)` +`QuantumCircuit.rxx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). @@ -2762,7 +2762,7 @@ A handle to the instructions created. -`QuantumCircuit.ry(theta, qubit, label=None)` +`QuantumCircuit.ry(theta, qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). @@ -2786,7 +2786,7 @@ A handle to the instructions created. -`QuantumCircuit.ryy(theta, qubit1, qubit2)` +`QuantumCircuit.ryy(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). @@ -2810,7 +2810,7 @@ A handle to the instructions created. -`QuantumCircuit.rz(phi, qubit)` +`QuantumCircuit.rz(phi, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). @@ -2833,7 +2833,7 @@ A handle to the instructions created. -`QuantumCircuit.rzx(theta, qubit1, qubit2)` +`QuantumCircuit.rzx(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). @@ -2857,7 +2857,7 @@ A handle to the instructions created. -`QuantumCircuit.rzz(theta, qubit1, qubit2)` +`QuantumCircuit.rzz(theta, qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). @@ -2881,7 +2881,7 @@ A handle to the instructions created. -`QuantumCircuit.s(qubit)` +`QuantumCircuit.s(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). @@ -3293,7 +3293,7 @@ with attached instruction. -`QuantumCircuit.sdg(qubit)` +`QuantumCircuit.sdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). @@ -3461,7 +3461,7 @@ with attached instruction. -`QuantumCircuit.size(filter_function=>)` +`QuantumCircuit.size(filter_function=>)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Returns total number of instructions in circuit. @@ -3539,7 +3539,7 @@ The single-qubit unitary instruction attached to the circuit. -`QuantumCircuit.swap(qubit1, qubit2)` +`QuantumCircuit.swap(qubit1, qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). @@ -3562,7 +3562,7 @@ A handle to the instructions created. -`QuantumCircuit.sx(qubit)` +`QuantumCircuit.sx(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). @@ -3584,7 +3584,7 @@ A handle to the instructions created. -`QuantumCircuit.sxdg(qubit)` +`QuantumCircuit.sxdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). @@ -3606,7 +3606,7 @@ A handle to the instructions created. -`QuantumCircuit.t(qubit)` +`QuantumCircuit.t(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). @@ -3628,7 +3628,7 @@ A handle to the instructions created. -`QuantumCircuit.tdg(qubit)` +`QuantumCircuit.tdg(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). @@ -3650,7 +3650,7 @@ A handle to the instructions created. -`QuantumCircuit.tensor(other, inplace=False)` +`QuantumCircuit.tensor(other, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Tensor `self` with `other`. @@ -3695,7 +3695,7 @@ The tensored circuit (returns None if inplace==True). -`QuantumCircuit.to_gate(parameter_map=None, label=None)` +`QuantumCircuit.to_gate(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Create a Gate out of this circuit. @@ -3716,7 +3716,7 @@ a composite gate encapsulating this circuit (can be decomposed back) -`QuantumCircuit.to_instruction(parameter_map=None, label=None)` +`QuantumCircuit.to_instruction(parameter_map=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Create an Instruction out of this circuit. @@ -3737,7 +3737,7 @@ a composite instruction encapsulating this circuit (can be decomposed back) -`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)` +`QuantumCircuit.toffoli(control_qubit1, control_qubit2, target_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). @@ -3765,7 +3765,7 @@ A handle to the instructions created. -`QuantumCircuit.u(theta, phi, lam, qubit)` +`QuantumCircuit.u(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). @@ -3927,7 +3927,7 @@ circuit.unitary(matrix, [0, 1]) -`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext` +`QuantumCircuit.while_loop(condition: Tuple[Union[qiskit.circuit.classicalregister.ClassicalRegister, qiskit.circuit.classicalregister.Clbit], int], body: None, qubits: None, clbits: None, *, label: Optional[str]) → qiskit.circuit.controlflow.while_loop.WhileLoopContext`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") @@ -3974,7 +3974,7 @@ If used in context-manager mode, then this should be used as a `with` resource, -`QuantumCircuit.width()` +`QuantumCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Return number of qubits plus clbits in circuit. @@ -3990,7 +3990,7 @@ int -`QuantumCircuit.x(qubit, label=None)` +`QuantumCircuit.x(qubit, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). @@ -4013,7 +4013,7 @@ A handle to the instructions created. -`QuantumCircuit.y(qubit)` +`QuantumCircuit.y(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). @@ -4035,7 +4035,7 @@ A handle to the instructions created. -`QuantumCircuit.z(qubit)` +`QuantumCircuit.z(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumcircuit.py "view source code") Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.41/qiskit.circuit.QuantumRegister.md index 5b3c383b6e2..1a1925bd515 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.QuantumRegister.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.QuantumRegister --- -# QuantumRegister[¶](#quantumregister "Permalink to this headline") +# QuantumRegister -`QuantumRegister(size=None, name=None, bits=None)` +`QuantumRegister(size=None, name=None, bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.register.Register` @@ -48,7 +48,7 @@ Find the index of the provided bit within this register. -`QuantumRegister.qasm()` +`QuantumRegister.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Return OPENQASM string for this register. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.41/qiskit.circuit.Qubit.md index a9312fd2071..522275d2040 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.Qubit.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.Qubit --- -# Qubit[¶](#qubit "Permalink to this headline") +# Qubit -`Qubit(register=None, index=None)` +`Qubit(register=None, index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/quantumregister.py "view source code") Bases: `qiskit.circuit.bit.Bit` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.WhileLoopOp.md b/docs/api/qiskit/0.41/qiskit.circuit.WhileLoopOp.md index baed753843f..a180e949bc9 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.WhileLoopOp.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.WhileLoopOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.WhileLoopOp --- -# WhileLoopOp[¶](#whileloopop "Permalink to this headline") +# WhileLoopOp -`WhileLoopOp(condition, body, label=None)` +`WhileLoopOp(condition, body, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") Bases: [`qiskit.circuit.controlflow.control_flow.ControlFlowOp`](qiskit.circuit.ControlFlowOp "qiskit.circuit.controlflow.control_flow.ControlFlowOp") @@ -98,7 +98,7 @@ Validation of the arguments. -`WhileLoopOp.c_if(classical, val)` +`WhileLoopOp.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -198,7 +198,7 @@ Containing the definition. -`WhileLoopOp.replace_blocks(blocks)` +`WhileLoopOp.replace_blocks(blocks)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/controlflow/while_loop.py "view source code") Replace blocks and return new instruction. :param blocks: Tuple of QuantumCircuits to replace in instruction. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.BooleanExpression.md b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.BooleanExpression.md index 993e1c28a8b..077e093cc1a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.classicalfunction.BooleanExpression --- -# BooleanExpression[¶](#booleanexpression "Permalink to this headline") +# BooleanExpression -`BooleanExpression(expression, name=None)` +`BooleanExpression(expression, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -158,7 +158,7 @@ updated if it was provided -`classmethod BooleanExpression.from_dimacs_file(filename)` +`classmethod BooleanExpression.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Create a BooleanExpression from the string in the DIMACS format. :type filename: `str` :param filename: A file in DIMACS format. @@ -288,7 +288,7 @@ sub-instructions reversed. -`BooleanExpression.simulate(bitstring)` +`BooleanExpression.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Evaluate the expression on a bitstring. @@ -330,7 +330,7 @@ bool -`BooleanExpression.synth(registerless=True, synthesizer=None)` +`BooleanExpression.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/boolean_expression.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunction.md b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunction.md index 13a755e3e5f..da86a0d15d6 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction --- -# ClassicalFunction[¶](#classicalfunction "Permalink to this headline") +# ClassicalFunction -`ClassicalFunction(source, name=None)` +`ClassicalFunction(source, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Bases: `qiskit.circuit.classicalfunction.classical_element.ClassicalElement` @@ -118,7 +118,7 @@ Set a classical equality condition on this instruction between the register or c -`ClassicalFunction.compile()` +`ClassicalFunction.compile()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Parses and creates the logical circuit @@ -284,7 +284,7 @@ sub-instructions reversed. -`ClassicalFunction.simulate(bitstring)` +`ClassicalFunction.simulate(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Evaluate the expression on a bitstring. @@ -306,7 +306,7 @@ bool -`ClassicalFunction.simulate_all()` +`ClassicalFunction.simulate_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Returns a truth table. @@ -342,7 +342,7 @@ bool -`ClassicalFunction.synth(registerless=True, synthesizer=None)` +`ClassicalFunction.synth(registerless=True, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/classicalfunction.py "view source code") Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md index 39847e9008e..08daec4fe67 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -6,11 +6,11 @@ python_api_type: exception python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError --- -# qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError[¶](#qiskit-circuit-classicalfunction-classicalfunctioncompilertypeerror "Permalink to this headline") +# qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError -`ClassicalFunctionCompilerTypeError(*message)` +`ClassicalFunctionCompilerTypeError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler type error. The classicalfunction function fails at type checking time. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md index 46876e9c8cd..e4ebbf0cbda 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -6,11 +6,11 @@ python_api_type: exception python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError --- -# qiskit.circuit.classicalfunction.ClassicalFunctionParseError[¶](#qiskit-circuit-classicalfunction-classicalfunctionparseerror "Permalink to this headline") +# qiskit.circuit.classicalfunction.ClassicalFunctionParseError -`ClassicalFunctionParseError(*message)` +`ClassicalFunctionParseError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/classicalfunction/exceptions.py "view source code") ClassicalFunction compiler parse error. The classicalfunction function fails at parsing time. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.AND.md b/docs/api/qiskit/0.41/qiskit.circuit.library.AND.md index 452d2adab78..7d1aa55fa5a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.AND.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.AND --- -# AND[¶](#and "Permalink to this headline") +# AND -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.Barrier.md b/docs/api/qiskit/0.41/qiskit.circuit.library.Barrier.md index b8536e99d44..75d4412b54c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.Barrier.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.Barrier --- -# Barrier[¶](#barrier "Permalink to this headline") +# Barrier -`Barrier(num_qubits, label=None)` +`Barrier(num_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -51,7 +51,7 @@ Assemble a QasmQobjInstruction -`Barrier.broadcast_arguments(qargs, cargs)` +`Barrier.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") Validation of the arguments. @@ -72,7 +72,7 @@ Validation of the arguments. -`Barrier.c_if(classical, val)` +`Barrier.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -106,7 +106,7 @@ updated if it was provided -`Barrier.inverse()` +`Barrier.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/barrier.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.C3SXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.C3SXGate.md index 5be05249e88..15f5ade71be 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.C3SXGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.C3SXGate --- -# C3SXGate[¶](#c3sxgate "Permalink to this headline") +# C3SXGate -`C3SXGate(label=None, ctrl_state=None)` +`C3SXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.C3XGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.C3XGate.md index 82f2ea1cf59..c2978779dee 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.C3XGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.C3XGate --- -# C3XGate[¶](#c3xgate "Permalink to this headline") +# C3XGate -`C3XGate(label=None, ctrl_state=None)` +`C3XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -26,7 +26,7 @@ Create a new 3-qubit controlled X gate. -`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`C3XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -48,7 +48,7 @@ controlled version of this gate. -`C3XGate.inverse()` +`C3XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.C4XGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.C4XGate.md index 9fda9e36729..de59fb942b6 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.C4XGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.C4XGate --- -# C4XGate[¶](#c4xgate "Permalink to this headline") +# C4XGate -`C4XGate(label=None, ctrl_state=None)` +`C4XGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -30,7 +30,7 @@ Create a new 4-qubit controlled X gate. -`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`C4XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -52,7 +52,7 @@ controlled version of this gate. -`C4XGate.inverse()` +`C4XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The C4X is its own inverse. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CCXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CCXGate.md index db5331e4124..71dd510e909 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CCXGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.CCXGate --- -# CCXGate[¶](#ccxgate "Permalink to this headline") +# CCXGate -`CCXGate(label=None, ctrl_state=None)` +`CCXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -82,7 +82,7 @@ Create new CCX gate. -`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`CCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Controlled version of this gate. @@ -104,7 +104,7 @@ controlled version of this gate. -`CCXGate.inverse()` +`CCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return an inverted CCX gate (also a CCX). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CDKMRippleCarryAdder.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CDKMRippleCarryAdder.md index a956217a70f..a46d0f9e905 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder --- -# CDKMRippleCarryAdder[¶](#cdkmripplecarryadder "Permalink to this headline") +# CDKMRippleCarryAdder -`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` +`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CHGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CHGate.md index 42733369ba8..9361f395f57 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CHGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.CHGate --- -# CHGate[¶](#chgate "Permalink to this headline") +# CHGate -`CHGate(label=None, ctrl_state=None)` +`CHGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -72,7 +72,7 @@ Create new CH gate. -`CHGate.inverse()` +`CHGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted CH gate (itself). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CPhaseGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CPhaseGate.md index 066740962a7..59e02db96b0 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CPhaseGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.CPhaseGate --- -# CPhaseGate[¶](#cphasegate "Permalink to this headline") +# CPhaseGate -`CPhaseGate(theta, label=None, ctrl_state=None)` +`CPhaseGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -53,7 +53,7 @@ Create new CPhase gate. -`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`CPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -75,7 +75,7 @@ controlled version of this gate. -`CPhaseGate.inverse()` +`CPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) @@ -83,7 +83,7 @@ Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) -`CPhaseGate.power(exponent)` +`CPhaseGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CRXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CRXGate.md index 564c01b4641..39e9e2fc093 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CRXGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.CRXGate --- -# CRXGate[¶](#crxgate "Permalink to this headline") +# CRXGate -`CRXGate(theta, label=None, ctrl_state=None)` +`CRXGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CRX gate. -`CRXGate.inverse()` +`CRXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverse CRX gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CRYGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CRYGate.md index ead414d374c..22a65b6ca0e 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CRYGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.CRYGate --- -# CRYGate[¶](#crygate "Permalink to this headline") +# CRYGate -`CRYGate(theta, label=None, ctrl_state=None)` +`CRYGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CRY gate. -`CRYGate.inverse()` +`CRYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverse CRY gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CRZGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CRZGate.md index 7cd19a8513e..289d94ce27a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CRZGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.CRZGate --- -# CRZGate[¶](#crzgate "Permalink to this headline") +# CRZGate -`CRZGate(theta, label=None, ctrl_state=None)` +`CRZGate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -76,7 +76,7 @@ Create new CRZ gate. -`CRZGate.inverse()` +`CRZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverse CRZ gate (i.e. with the negative rotation angle). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CSXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CSXGate.md index f15e94738a0..3e628baa9b6 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CSXGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.CSXGate --- -# CSXGate[¶](#csxgate "Permalink to this headline") +# CSXGate -`CSXGate(label=None, ctrl_state=None)` +`CSXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CSwapGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CSwapGate.md index 0be3c2fb484..8e1f38635f4 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CSwapGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.CSwapGate --- -# CSwapGate[¶](#cswapgate "Permalink to this headline") +# CSwapGate -`CSwapGate(label=None, ctrl_state=None)` +`CSwapGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -89,7 +89,7 @@ Create new CSWAP gate. -`CSwapGate.inverse()` +`CSwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse CSwap gate (itself). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CU1Gate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CU1Gate.md index dc80a9b8c07..3a34cf79725 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CU1Gate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.CU1Gate --- -# CU1Gate[¶](#cu1gate "Permalink to this headline") +# CU1Gate -`CU1Gate(theta, label=None, ctrl_state=None)` +`CU1Gate(theta, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -51,7 +51,7 @@ Create new CU1 gate. -`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`CU1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Controlled version of this gate. @@ -73,7 +73,7 @@ controlled version of this gate. -`CU1Gate.inverse()` +`CU1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted CU1 gate ($CU1(\lambda){\dagger} = CU1(-\lambda)$) diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CU3Gate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CU3Gate.md index e84fb222e24..b1967837ce1 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CU3Gate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.CU3Gate --- -# CU3Gate[¶](#cu3gate "Permalink to this headline") +# CU3Gate -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -72,7 +72,7 @@ Create new CU3 gate. -`CU3Gate.inverse()` +`CU3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted CU3 gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CUGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CUGate.md index 3108cbe409a..31adfab3941 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CUGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.CUGate --- -# CUGate[¶](#cugate "Permalink to this headline") +# CUGate -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -74,7 +74,7 @@ Create new CU gate. -`CUGate.inverse()` +`CUGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted CU gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CXGate.md index bc75480fda5..4bf901fe96e 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CXGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.CXGate --- -# CXGate[¶](#cxgate "Permalink to this headline") +# CXGate -`CXGate(label=None, ctrl_state=None)` +`CXGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -76,7 +76,7 @@ Create new CX gate. -`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`CXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return a controlled-X gate with more control lines. @@ -98,7 +98,7 @@ controlled version of this gate. -`CXGate.inverse()` +`CXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted CX gate (itself). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CYGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CYGate.md index 9b2899b6578..61e42f333e3 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CYGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.CYGate --- -# CYGate[¶](#cygate "Permalink to this headline") +# CYGate -`CYGate(label=None, ctrl_state=None)` +`CYGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -70,7 +70,7 @@ Create new CY gate. -`CYGate.inverse()` +`CYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted CY gate (itself). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.CZGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.CZGate.md index 0e59ea8a228..d49aef13e1c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.CZGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.CZGate --- -# CZGate[¶](#czgate "Permalink to this headline") +# CZGate -`CZGate(label=None, ctrl_state=None)` +`CZGate(label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -51,7 +51,7 @@ Create new CZ gate. -`CZGate.inverse()` +`CZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted CZ gate (itself). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.DCXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.DCXGate.md index 86d698eb1dc..32af862167c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.DCXGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.DCXGate --- -# DCXGate[¶](#dcxgate "Permalink to this headline") +# DCXGate -`DCXGate` +`DCXGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/dcx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.Diagonal.md b/docs/api/qiskit/0.41/qiskit.circuit.library.Diagonal.md index faf4dc94b5c..08b2ae69e8f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.Diagonal.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.Diagonal --- -# Diagonal[¶](#diagonal "Permalink to this headline") +# Diagonal -`Diagonal(diag)` +`Diagonal(diag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/diagonal.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.DraperQFTAdder.md b/docs/api/qiskit/0.41/qiskit.circuit.library.DraperQFTAdder.md index af07b536062..4348087ea01 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.DraperQFTAdder.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.DraperQFTAdder --- -# DraperQFTAdder[¶](#draperqftadder "Permalink to this headline") +# DraperQFTAdder -`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` +`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.ECRGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.ECRGate.md index deaba50aeb3..86c6f9aa0bf 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.ECRGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.ECRGate --- -# ECRGate[¶](#ecrgate "Permalink to this headline") +# ECRGate -`ECRGate` +`ECRGate`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ecr.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -72,7 +72,7 @@ Create new ECR gate. -`ECRGate.to_matrix()` +`ECRGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ecr.py "view source code") Return a numpy.array for the ECR gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.EfficientSU2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.EfficientSU2.md index 60f4fd19f31..5539478e04f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.EfficientSU2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.EfficientSU2 --- -# EfficientSU2[¶](#efficientsu2 "Permalink to this headline") +# EfficientSU2 -`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')` +`EfficientSU2(num_qubits=None, su2_gates=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='EfficientSU2')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/efficient_su2.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.EvolvedOperatorAnsatz.md b/docs/api/qiskit/0.41/qiskit.circuit.library.EvolvedOperatorAnsatz.md index 40fee873a20..4e6f2a5952b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz --- -# EvolvedOperatorAnsatz[¶](#evolvedoperatoransatz "Permalink to this headline") +# EvolvedOperatorAnsatz -`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)` +`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', parameter_prefix='t', initial_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/evolved_operator_ansatz.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.ExactReciprocal.md b/docs/api/qiskit/0.41/qiskit.circuit.library.ExactReciprocal.md index 8ac008ebf9b..41674696f67 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.ExactReciprocal.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.ExactReciprocal.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.ExactReciprocal --- -# ExactReciprocal[¶](#exactreciprocal "Permalink to this headline") +# ExactReciprocal -`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')` +`ExactReciprocal(num_state_qubits, scaling, neg_vals=False, name='1/x')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/exact_reciprocal.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.ExcitationPreserving.md b/docs/api/qiskit/0.41/qiskit.circuit.library.ExcitationPreserving.md index 7ee1ecc3b69..1420de6b681 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.ExcitationPreserving.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.ExcitationPreserving --- -# ExcitationPreserving[¶](#excitationpreserving "Permalink to this headline") +# ExcitationPreserving -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')` +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.FourierChecking.md b/docs/api/qiskit/0.41/qiskit.circuit.library.FourierChecking.md index 1acfd1cfb64..2eefc92d4b5 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.FourierChecking.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.FourierChecking --- -# FourierChecking[¶](#fourierchecking "Permalink to this headline") +# FourierChecking -`FourierChecking(f, g)` +`FourierChecking(f, g)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/fourier_checking.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.FunctionalPauliRotations.md b/docs/api/qiskit/0.41/qiskit.circuit.library.FunctionalPauliRotations.md index bcfe385e484..eeb8cd28968 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.FunctionalPauliRotations.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.FunctionalPauliRotations --- -# FunctionalPauliRotations[¶](#functionalpaulirotations "Permalink to this headline") +# FunctionalPauliRotations -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GMS.md b/docs/api/qiskit/0.41/qiskit.circuit.library.GMS.md index 30920cf232b..78768341237 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GMS.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.GMS --- -# GMS[¶](#gms "Permalink to this headline") +# GMS -`GMS(num_qubits, theta)` +`GMS(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GR.md b/docs/api/qiskit/0.41/qiskit.circuit.library.GR.md index eb5cb469351..6c728d98a2d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GR.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.GR --- -# GR[¶](#gr "Permalink to this headline") +# GR -`GR(num_qubits, theta, phi)` +`GR(num_qubits, theta, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GRX.md b/docs/api/qiskit/0.41/qiskit.circuit.library.GRX.md index 9c3da9435e2..e01257aea07 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GRX.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.GRX --- -# GRX[¶](#grx "Permalink to this headline") +# GRX -`GRX(num_qubits, theta)` +`GRX(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GRY.md b/docs/api/qiskit/0.41/qiskit.circuit.library.GRY.md index 2acb31c4688..fda26f23327 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GRY.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.GRY --- -# GRY[¶](#gry "Permalink to this headline") +# GRY -`GRY(num_qubits, theta)` +`GRY(num_qubits, theta)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.gr.GR`](qiskit.circuit.library.GR "qiskit.circuit.library.generalized_gates.gr.GR") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GRZ.md b/docs/api/qiskit/0.41/qiskit.circuit.library.GRZ.md index 520327c5674..2b732796e8c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GRZ.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.GRZ --- -# GRZ[¶](#grz "Permalink to this headline") +# GRZ -`GRZ(num_qubits, phi)` +`GRZ(num_qubits, phi)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gr.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GraphState.md b/docs/api/qiskit/0.41/qiskit.circuit.library.GraphState.md index 3d316f81308..1d70874a5c7 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GraphState.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.GraphState --- -# GraphState[¶](#graphstate "Permalink to this headline") +# GraphState -`GraphState(adjacency_matrix)` +`GraphState(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/graph_state.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.GroverOperator.md b/docs/api/qiskit/0.41/qiskit.circuit.library.GroverOperator.md index 61aa74b24a5..33c2c2b67c5 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.GroverOperator.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.GroverOperator --- -# GroverOperator[¶](#groveroperator "Permalink to this headline") +# GroverOperator -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/grover_operator.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.HGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.HGate.md index 6cf8b9963c8..8469bf47116 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.HGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.HGate --- -# HGate[¶](#hgate "Permalink to this headline") +# HGate -`HGate(label=None)` +`HGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -46,7 +46,7 @@ Create new H gate. -`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`HGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Return a (multi-)controlled-H gate. @@ -70,7 +70,7 @@ controlled version of this gate. -`HGate.inverse()` +`HGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/h.py "view source code") Return inverted H gate (itself). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.HRSCumulativeMultiplier.md b/docs/api/qiskit/0.41/qiskit.circuit.library.HRSCumulativeMultiplier.md index 687722ed869..e018824d186 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier --- -# HRSCumulativeMultiplier[¶](#hrscumulativemultiplier "Permalink to this headline") +# HRSCumulativeMultiplier -`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` +`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.HiddenLinearFunction.md b/docs/api/qiskit/0.41/qiskit.circuit.library.HiddenLinearFunction.md index ec4a8e219e7..0db99e58035 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.HiddenLinearFunction.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.HiddenLinearFunction --- -# HiddenLinearFunction[¶](#hiddenlinearfunction "Permalink to this headline") +# HiddenLinearFunction -`HiddenLinearFunction(adjacency_matrix)` +`HiddenLinearFunction(adjacency_matrix)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/hidden_linear_function.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.IGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.IGate.md index 076ff734b57..f7424870926 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.IGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.IGate --- -# IGate[¶](#igate "Permalink to this headline") +# IGate -`IGate(label=None)` +`IGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -45,7 +45,7 @@ Create new Identity gate. -`IGate.inverse()` +`IGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") Invert this gate. @@ -53,7 +53,7 @@ Invert this gate. -`IGate.power(exponent)` +`IGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/i.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.IQP.md b/docs/api/qiskit/0.41/qiskit.circuit.library.IQP.md index 7dfd5a7a710..4f350f958b8 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.IQP.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.IQP --- -# IQP[¶](#iqp "Permalink to this headline") +# IQP -`IQP(interactions)` +`IQP(interactions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/iqp.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.InnerProduct.md b/docs/api/qiskit/0.41/qiskit.circuit.library.InnerProduct.md index fda91b9bae0..596a9cf80fe 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.InnerProduct.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.InnerProduct --- -# InnerProduct[¶](#innerproduct "Permalink to this headline") +# InnerProduct -`InnerProduct(num_qubits)` +`InnerProduct(num_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/inner_product.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.IntegerComparator.md b/docs/api/qiskit/0.41/qiskit.circuit.library.IntegerComparator.md index 4332cb14682..ea4a4c6caf3 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.IntegerComparator.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.IntegerComparator --- -# IntegerComparator[¶](#integercomparator "Permalink to this headline") +# IntegerComparator -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.LinearAmplitudeFunction.md b/docs/api/qiskit/0.41/qiskit.circuit.library.LinearAmplitudeFunction.md index c4680070cc3..7d7ff2dca4a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.LinearAmplitudeFunction --- -# LinearAmplitudeFunction[¶](#linearamplitudefunction "Permalink to this headline") +# LinearAmplitudeFunction -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -74,7 +74,7 @@ Quantum-Enhanced Simulation-Based Optimization. [arXiv:2005.10780](http://arxiv. -`LinearAmplitudeFunction.post_processing(scaled_value)` +`LinearAmplitudeFunction.post_processing(scaled_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Map the function value of the approximated $\hat{f}$ to $f$. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.LinearFunction.md b/docs/api/qiskit/0.41/qiskit.circuit.library.LinearFunction.md index b3c62a36d6e..e622abff0a2 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.LinearFunction.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.LinearFunction.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.LinearFunction --- -# LinearFunction[¶](#linearfunction "Permalink to this headline") +# LinearFunction -`LinearFunction(linear, validate_input=False)` +`LinearFunction(linear, validate_input=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -63,7 +63,7 @@ Create a new linear function. -`LinearFunction.is_permutation()` +`LinearFunction.is_permutation()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Returns whether this linear function is a permutation, that is whether every row and every column of the n x n matrix has exactly one 1. @@ -75,7 +75,7 @@ Returns whether this linear function is a permutation, that is whether every row -`LinearFunction.permutation_pattern()` +`LinearFunction.permutation_pattern()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") This method first checks if a linear function is a permutation and raises a qiskit.circuit.exceptions.CircuitError if not. In the case that this linear function is a permutation, returns the permutation pattern. @@ -83,7 +83,7 @@ This method first checks if a linear function is a permutation and raises a qisk -`LinearFunction.synthesize()` +`LinearFunction.synthesize()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Synthesizes the linear function into a quantum circuit. @@ -99,7 +99,7 @@ A circuit implementing the evolution. -`LinearFunction.validate_parameter(parameter)` +`LinearFunction.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/linear_function.py "view source code") Parameter validation diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.LinearPauliRotations.md b/docs/api/qiskit/0.41/qiskit.circuit.library.LinearPauliRotations.md index 40e9c921711..7c7a98b3fe6 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.LinearPauliRotations.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.LinearPauliRotations --- -# LinearPauliRotations[¶](#linearpaulirotations "Permalink to this headline") +# LinearPauliRotations -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCMT.md b/docs/api/qiskit/0.41/qiskit.circuit.library.MCMT.md index d37484503fc..2ad4cb0a00d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCMT.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.MCMT --- -# MCMT[¶](#mcmt "Permalink to this headline") +# MCMT -`MCMT(gate, num_ctrl_qubits, num_target_qubits)` +`MCMT(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -52,7 +52,7 @@ Create a new multi-control multi-target gate. -`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`MCMT.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the controlled version of the MCMT circuit. @@ -60,7 +60,7 @@ Return the controlled version of the MCMT circuit. -`MCMT.inverse()` +`MCMT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCMTVChain.md b/docs/api/qiskit/0.41/qiskit.circuit.library.MCMTVChain.md index 654b80a5e27..fc0822f5785 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCMTVChain.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.MCMTVChain --- -# MCMTVChain[¶](#mcmtvchain "Permalink to this headline") +# MCMTVChain -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)` +`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Bases: [`qiskit.circuit.library.generalized_gates.mcmt.MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.generalized_gates.mcmt.MCMT") @@ -76,7 +76,7 @@ Create a new multi-control multi-target gate. -`MCMTVChain.inverse()` +`MCMTVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/mcmt.py "view source code") Return the inverse MCMT circuit, which is itself. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCPhaseGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.MCPhaseGate.md index e9eda60fdb3..0183c097408 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCPhaseGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.MCPhaseGate --- -# MCPhaseGate[¶](#mcphasegate "Permalink to this headline") +# MCPhaseGate -`MCPhaseGate(lam, num_ctrl_qubits, label=None)` +`MCPhaseGate(lam, num_ctrl_qubits, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -45,7 +45,7 @@ Create new MCPhase gate. -`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`MCPhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Controlled version of this gate. @@ -67,7 +67,7 @@ controlled version of this gate. -`MCPhaseGate.inverse()` +`MCPhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted MCU1 gate ($MCU1(\lambda){\dagger} = MCU1(-\lambda)$) diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGate.md index 6d698ab6008..dd69b71ebf0 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.MCXGate --- -# MCXGate[¶](#mcxgate "Permalink to this headline") +# MCXGate -`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')` +`MCXGate(num_ctrl_qubits, label=None, ctrl_state=None, _name='mcx')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.controlledgate.ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.controlledgate.ControlledGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`MCXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return a multi-controlled-X gate with more control lines. @@ -48,7 +48,7 @@ controlled version of this gate. -`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')` +`static MCXGate.get_num_ancilla_qubits(num_ctrl_qubits, mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits without instantiating the class. @@ -62,7 +62,7 @@ This staticmethod might be necessary to check the number of ancillas before crea -`MCXGate.inverse()` +`MCXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGrayCode.md b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGrayCode.md index a108e1dbbdc..a7da7d059ce 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXGrayCode.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.MCXGrayCode --- -# MCXGrayCode[¶](#mcxgraycode "Permalink to this headline") +# MCXGrayCode -`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)` +`MCXGrayCode(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`MCXGrayCode.inverse()` +`MCXGrayCode.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXRecursive.md b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXRecursive.md index 4298ed8548c..9f1cde91398 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXRecursive.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.MCXRecursive --- -# MCXRecursive[¶](#mcxrecursive "Permalink to this headline") +# MCXRecursive -`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)` +`MCXRecursive(num_ctrl_qubits, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -26,7 +26,7 @@ Create new MCX gate. -`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')` +`static MCXRecursive.get_num_ancilla_qubits(num_ctrl_qubits, mode='recursion')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -34,7 +34,7 @@ Get the number of required ancilla qubits. -`MCXRecursive.inverse()` +`MCXRecursive.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXVChain.md b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXVChain.md index d8e948e5b5f..d8759215a46 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MCXVChain.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.MCXVChain --- -# MCXVChain[¶](#mcxvchain "Permalink to this headline") +# MCXVChain -`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)` +`MCXVChain(num_ctrl_qubits, dirty_ancillas=False, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.library.standard_gates.x.MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.standard_gates.x.MCXGate") @@ -24,7 +24,7 @@ Create new MCX gate. -`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')` +`static MCXVChain.get_num_ancilla_qubits(num_ctrl_qubits, mode='v-chain')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Get the number of required ancilla qubits. @@ -32,7 +32,7 @@ Get the number of required ancilla qubits. -`MCXVChain.inverse()` +`MCXVChain.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Invert this gate. The MCX is its own inverse. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.MSGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.MSGate.md index 105a9c68009..b51b1906508 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.MSGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.MSGate --- -# MSGate[¶](#msgate "Permalink to this headline") +# MSGate -`MSGate(num_qubits, theta, label=None)` +`MSGate(num_qubits, theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/gms.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.Measure.md b/docs/api/qiskit/0.41/qiskit.circuit.library.Measure.md index 3d5e036b09c..f03c9d89380 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.Measure.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.Measure --- -# Measure[¶](#measure "Permalink to this headline") +# Measure -`Measure` +`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/measure.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Measure.broadcast_arguments(qargs, cargs)` +`Measure.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/measure.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.NLocal.md b/docs/api/qiskit/0.41/qiskit.circuit.library.NLocal.md index 95f525b2531..b74885a5c34 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.NLocal.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.NLocal --- -# NLocal[¶](#nlocal "Permalink to this headline") +# NLocal -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -74,7 +74,7 @@ TODO -`NLocal.add_layer(other, entanglement=None, front=False)` +`NLocal.add_layer(other, entanglement=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Append another layer to the NLocal. @@ -100,7 +100,7 @@ self, such that chained composes are possible. -`NLocal.assign_parameters(parameters, inplace=False)` +`NLocal.assign_parameters(parameters, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Assign parameters to the n-local circuit. @@ -122,7 +122,7 @@ A copy of the NLocal circuit with the specified parameters. -`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` +`NLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Get the entangler map for in the repetition `rep_num` and the block `block_num`. @@ -165,7 +165,7 @@ The entangler map for the current block in the current repetition. -`NLocal.get_unentangled_qubits()` +`NLocal.get_unentangled_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Get the indices of unentangled qubits in a set. @@ -181,7 +181,7 @@ The unentangled qubits. -`NLocal.print_settings()` +`NLocal.print_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/n_local.py "view source code") Returns information about the setting. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.OR.md b/docs/api/qiskit/0.41/qiskit.circuit.library.OR.md index 0ace7145d36..73f2a872225 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.OR.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.OR --- -# OR[¶](#or "Permalink to this headline") +# OR -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliEvolutionGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliEvolutionGate.md index 7ad792fe02b..3297045e664 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliEvolutionGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliEvolutionGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.PauliEvolutionGate --- -# PauliEvolutionGate[¶](#paulievolutiongate "Permalink to this headline") +# PauliEvolutionGate -`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)` +`PauliEvolutionGate(operator, time=1.0, label=None, synthesis=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/pauli_evolution.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -74,7 +74,7 @@ q_1: ┤1 ├ -`PauliEvolutionGate.validate_parameter(parameter)` +`PauliEvolutionGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/pauli_evolution.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliFeatureMap.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliFeatureMap.md index 65ab46a38fa..5f93ac52f0d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliFeatureMap.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.PauliFeatureMap --- -# PauliFeatureMap[¶](#paulifeaturemap "Permalink to this headline") +# PauliFeatureMap -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -112,7 +112,7 @@ Create a new Pauli expansion circuit. -`PauliFeatureMap.pauli_block(pauli_string)` +`PauliFeatureMap.pauli_block(pauli_string)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the Pauli block for the feature map circuit. @@ -120,7 +120,7 @@ Get the Pauli block for the feature map circuit. -`PauliFeatureMap.pauli_evolution(pauli_string, time)` +`PauliFeatureMap.pauli_evolution(pauli_string, time)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Get the evolution block for the given pauli string. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliGate.md index 5d2dbb8fbc8..3fc6b245319 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.PauliGate --- -# PauliGate[¶](#pauligate "Permalink to this headline") +# PauliGate -`PauliGate(label)` +`PauliGate(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -37,7 +37,7 @@ Create a new gate. -`PauliGate.inverse()` +`PauliGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Return inverted pauli gate (itself). @@ -45,7 +45,7 @@ Return inverted pauli gate (itself). -`PauliGate.validate_parameter(parameter)` +`PauliGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/pauli.py "view source code") Gate parameters should be int, float, or ParameterExpression diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliTwoDesign.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliTwoDesign.md index 17b2960f37e..f32a1dbe458 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PauliTwoDesign.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.PauliTwoDesign --- -# PauliTwoDesign[¶](#paulitwodesign "Permalink to this headline") +# PauliTwoDesign -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.Permutation.md b/docs/api/qiskit/0.41/qiskit.circuit.library.Permutation.md index fb7087659cf..cf71e047c94 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.Permutation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.Permutation --- -# Permutation[¶](#permutation "Permalink to this headline") +# Permutation -`Permutation(num_qubits, pattern=None, seed=None)` +`Permutation(num_qubits, pattern=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PermutationGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PermutationGate.md index f7a5905db1d..f51e64bf365 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PermutationGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PermutationGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.PermutationGate --- -# PermutationGate[¶](#permutationgate "Permalink to this headline") +# PermutationGate -`PermutationGate(pattern)` +`PermutationGate(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -40,7 +40,7 @@ Return a permutation gate. -`PermutationGate.inverse()` +`PermutationGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Returns the inverse of the permutation. @@ -48,7 +48,7 @@ Returns the inverse of the permutation. -`PermutationGate.qasm()` +`PermutationGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") The qasm for a permutation. @@ -56,7 +56,7 @@ The qasm for a permutation. -`PermutationGate.validate_parameter(parameter)` +`PermutationGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/permutation.py "view source code") Parameter validation. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseEstimation.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseEstimation.md index ff4443479b9..bdfc3671b21 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseEstimation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.PhaseEstimation --- -# PhaseEstimation[¶](#phaseestimation "Permalink to this headline") +# PhaseEstimation -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_estimation.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseGate.md index f77aa258290..edac42d9b58 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.PhaseGate --- -# PhaseGate[¶](#phasegate "Permalink to this headline") +# PhaseGate -`PhaseGate(theta, label=None)` +`PhaseGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new Phase gate. -`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`PhaseGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Return a (multi-)controlled-Phase gate. @@ -92,7 +92,7 @@ controlled version of this gate. -`PhaseGate.inverse()` +`PhaseGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) @@ -100,7 +100,7 @@ Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) -`PhaseGate.power(exponent)` +`PhaseGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/p.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseOracle.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseOracle.md index 61b5974d70c..3894908d00a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PhaseOracle.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.PhaseOracle --- -# PhaseOracle[¶](#phaseoracle "Permalink to this headline") +# PhaseOracle -`PhaseOracle(expression, synthesizer=None)` +`PhaseOracle(expression, synthesizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -35,7 +35,7 @@ Creates a PhaseOracle object -`PhaseOracle.evaluate_bitstring(bitstring)` +`PhaseOracle.evaluate_bitstring(bitstring)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") Evaluate the oracle on a bitstring. This evaluation is done classically without any quantum circuit. @@ -55,7 +55,7 @@ True if the bitstring is a good state, False otherwise. -`classmethod PhaseOracle.from_dimacs_file(filename)` +`classmethod PhaseOracle.from_dimacs_file(filename)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/phase_oracle.py "view source code") Create a PhaseOracle from the string in the DIMACS format. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseChebyshev.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseChebyshev.md index b8bf8dea310..86106336f71 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseChebyshev.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.PiecewiseChebyshev --- -# PiecewiseChebyshev[¶](#piecewisechebyshev "Permalink to this headline") +# PiecewiseChebyshev -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseLinearPauliRotations.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseLinearPauliRotations.md index ec46757a73a..02133ea4ef2 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations --- -# PiecewiseLinearPauliRotations[¶](#piecewiselinearpaulirotations "Permalink to this headline") +# PiecewiseLinearPauliRotations -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -44,7 +44,7 @@ Construct piecewise-linearly-controlled Pauli rotations. -`PiecewiseLinearPauliRotations.evaluate(x)` +`PiecewiseLinearPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Classically evaluate the piecewise linear rotation. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md index 2cbf77bad62..b21ac902916 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations --- -# PiecewisePolynomialPauliRotations[¶](#piecewisepolynomialpaulirotations "Permalink to this headline") +# PiecewisePolynomialPauliRotations -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") @@ -88,7 +88,7 @@ Enhancing the Quantum Linear Systems Algorithm using Richardson Extrapolation. [ -`PiecewisePolynomialPauliRotations.evaluate(x)` +`PiecewisePolynomialPauliRotations.evaluate(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Classically evaluate the piecewise polynomial rotation. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.PolynomialPauliRotations.md b/docs/api/qiskit/0.41/qiskit.circuit.library.PolynomialPauliRotations.md index e88cfac403b..0a2bfa28d1c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.PolynomialPauliRotations.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.PolynomialPauliRotations --- -# PolynomialPauliRotations[¶](#polynomialpaulirotations "Permalink to this headline") +# PolynomialPauliRotations -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')` +`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', name='poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/polynomial_pauli_rotations.py "view source code") Bases: [`qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.QAOAAnsatz.md b/docs/api/qiskit/0.41/qiskit.circuit.library.QAOAAnsatz.md index 983cb681675..ea6b72f7cf6 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.QAOAAnsatz.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.QAOAAnsatz --- -# QAOAAnsatz[¶](#qaoaansatz "Permalink to this headline") +# QAOAAnsatz -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')` +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: [`qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.QFT.md b/docs/api/qiskit/0.41/qiskit.circuit.library.QFT.md index 69cdb8cf1f7..76bb505adf4 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.QFT.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.QFT --- -# QFT[¶](#qft "Permalink to this headline") +# QFT -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -55,7 +55,7 @@ Construct a new QFT circuit. -`QFT.inverse()` +`QFT.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") Invert this circuit. @@ -71,7 +71,7 @@ The inverted circuit. -`QFT.is_inverse()` +`QFT.is_inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/basis_change/qft.py "view source code") Whether the inverse Fourier transform is implemented. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.QuadraticForm.md b/docs/api/qiskit/0.41/qiskit.circuit.library.QuadraticForm.md index bd37927cbd9..cb0567ad66d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.QuadraticForm.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.QuadraticForm --- -# QuadraticForm[¶](#quadraticform "Permalink to this headline") +# QuadraticForm -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") @@ -61,7 +61,7 @@ The implementation of this circuit is discussed in \[1], Fig. 6. -`static QuadraticForm.required_result_qubits(quadratic, linear, offset)` +`static QuadraticForm.required_result_qubits(quadratic, linear, offset)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Get the number of required result qubits. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.QuantumVolume.md b/docs/api/qiskit/0.41/qiskit.circuit.library.QuantumVolume.md index 2ca8e57a991..60f5f99f786 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.QuantumVolume.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.QuantumVolume --- -# QuantumVolume[¶](#quantumvolume "Permalink to this headline") +# QuantumVolume -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/quantum_volume.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RC3XGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RC3XGate.md index 9ac1d753405..81a343498b6 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RC3XGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.RC3XGate --- -# RC3XGate[¶](#rc3xgate "Permalink to this headline") +# RC3XGate -`RC3XGate(label=None)` +`RC3XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RCCXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RCCXGate.md index 6c689e8a307..14ba96a8aa1 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RCCXGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.RCCXGate --- -# RCCXGate[¶](#rccxgate "Permalink to this headline") +# RCCXGate -`RCCXGate(label=None)` +`RCCXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RGQFTMultiplier.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RGQFTMultiplier.md index 8b527e589a3..348f968899b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RGQFTMultiplier.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.RGQFTMultiplier --- -# RGQFTMultiplier[¶](#rgqftmultiplier "Permalink to this headline") +# RGQFTMultiplier -`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` +`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RGate.md index 9904936ffe5..0de358c93c6 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.RGate --- -# RGate[¶](#rgate "Permalink to this headline") +# RGate -`RGate(theta, phi, label=None)` +`RGate(theta, phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new r single-qubit gate. -`RGate.inverse()` +`RGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") Invert this gate. @@ -54,7 +54,7 @@ r(θ, φ)^dagger = r(-θ, φ) -`RGate.power(exponent)` +`RGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/r.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RVGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RVGate.md index 991cace1ebf..e4dbcee741a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RVGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.RVGate --- -# RVGate[¶](#rvgate "Permalink to this headline") +# RVGate -`RVGate(v_x, v_y, v_z, basis='U')` +`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -53,7 +53,7 @@ Create new rv single-qubit gate. -`RVGate.inverse()` +`RVGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") Invert this gate. @@ -61,7 +61,7 @@ Invert this gate. -`RVGate.to_matrix()` +`RVGate.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/generalized_gates/rv.py "view source code") Return a numpy.array for the R(v) gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RXGate.md index 3780606cc81..87c03d6b6f2 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RXGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.RXGate --- -# RXGate[¶](#rxgate "Permalink to this headline") +# RXGate -`RXGate(theta, label=None)` +`RXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new RX gate. -`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`RXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Return a (multi-)controlled-RX gate. @@ -66,7 +66,7 @@ controlled version of this gate. -`RXGate.inverse()` +`RXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Return inverted RX gate. @@ -76,7 +76,7 @@ $RX(\lambda)^{\dagger} = RX(-\lambda)$ -`RXGate.power(exponent)` +`RXGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rx.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RXXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RXXGate.md index f9a4ce5f710..cfd9f8b60d0 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RXXGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.RXXGate --- -# RXXGate[¶](#rxxgate "Permalink to this headline") +# RXXGate -`RXXGate(theta, label=None)` +`RXXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new RXX gate. -`RXXGate.inverse()` +`RXXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") Return inverse RXX gate (i.e. with the negative rotation angle). @@ -78,7 +78,7 @@ Return inverse RXX gate (i.e. with the negative rotation angle). -`RXXGate.power(exponent)` +`RXXGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rxx.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RYGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RYGate.md index d9339622d97..e74136d5b85 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RYGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.RYGate --- -# RYGate[¶](#rygate "Permalink to this headline") +# RYGate -`RYGate(theta, label=None)` +`RYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -44,7 +44,7 @@ Create new RY gate. -`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`RYGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Return a (multi-)controlled-RY gate. @@ -66,7 +66,7 @@ controlled version of this gate. -`RYGate.inverse()` +`RYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Return inverted RY gate. @@ -76,7 +76,7 @@ $RY(\lambda){\dagger} = RY(-\lambda)$ -`RYGate.power(exponent)` +`RYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ry.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RYYGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RYYGate.md index 5b4e208945b..c8de5d40a44 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RYYGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.RYYGate --- -# RYYGate[¶](#ryygate "Permalink to this headline") +# RYYGate -`RYYGate(theta, label=None)` +`RYYGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -70,7 +70,7 @@ Create new RYY gate. -`RYYGate.inverse()` +`RYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") Return inverse RYY gate (i.e. with the negative rotation angle). @@ -78,7 +78,7 @@ Return inverse RYY gate (i.e. with the negative rotation angle). -`RYYGate.power(exponent)` +`RYYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/ryy.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RZGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RZGate.md index 436775ff4a9..85fa328b294 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RZGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.RZGate --- -# RZGate[¶](#rzgate "Permalink to this headline") +# RZGate -`RZGate(phi, label=None)` +`RZGate(phi, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -56,7 +56,7 @@ Create new RZ gate. -`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`RZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Return a (multi-)controlled-RZ gate. @@ -78,7 +78,7 @@ controlled version of this gate. -`RZGate.inverse()` +`RZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Return inverted RZ gate @@ -88,7 +88,7 @@ $RZ(\lambda){\dagger} = RZ(-\lambda)$ -`RZGate.power(exponent)` +`RZGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rz.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RZXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RZXGate.md index f3fb41aae81..f5ed86678ae 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RZXGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.RZXGate --- -# RZXGate[¶](#rzxgate "Permalink to this headline") +# RZXGate -`RZXGate(theta, label=None)` +`RZXGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -108,7 +108,7 @@ Create new RZX gate. -`RZXGate.inverse()` +`RZXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") Return inverse RZX gate (i.e. with the negative rotation angle). @@ -116,7 +116,7 @@ Return inverse RZX gate (i.e. with the negative rotation angle). -`RZXGate.power(exponent)` +`RZXGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzx.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RZZGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RZZGate.md index cd587ce142e..ac5b92a837e 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RZZGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.RZZGate --- -# RZZGate[¶](#rzzgate "Permalink to this headline") +# RZZGate -`RZZGate(theta, label=None)` +`RZZGate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -82,7 +82,7 @@ Create new RZZ gate. -`RZZGate.inverse()` +`RZZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") Return inverse RZZ gate (i.e. with the negative rotation angle). @@ -90,7 +90,7 @@ Return inverse RZZ gate (i.e. with the negative rotation angle). -`RZZGate.power(exponent)` +`RZZGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/rzz.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.RealAmplitudes.md b/docs/api/qiskit/0.41/qiskit.circuit.library.RealAmplitudes.md index e91b8cdb547..3307fd8d6fc 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.RealAmplitudes.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.RealAmplitudes --- -# RealAmplitudes[¶](#realamplitudes "Permalink to this headline") +# RealAmplitudes -`RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')` +`RealAmplitudes(num_qubits=None, entanglement='reverse_linear', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='RealAmplitudes')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/real_amplitudes.py "view source code") Bases: [`qiskit.circuit.library.n_local.two_local.TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.n_local.two_local.TwoLocal") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.Reset.md b/docs/api/qiskit/0.41/qiskit.circuit.library.Reset.md index 937f6360852..6205e0ff1b1 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.Reset.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.Reset --- -# Reset[¶](#reset "Permalink to this headline") +# Reset -`Reset` +`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/reset.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -40,7 +40,7 @@ Assemble a QasmQobjInstruction -`Reset.broadcast_arguments(qargs, cargs)` +`Reset.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/reset.py "view source code") Validation of the arguments. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.SGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.SGate.md index 1325116cbe0..39dafb99cf8 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.SGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.SGate --- -# SGate[¶](#sgate "Permalink to this headline") +# SGate -`SGate(label=None)` +`SGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new S gate. -`SGate.inverse()` +`SGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of S (SdgGate). @@ -57,7 +57,7 @@ Return inverse of S (SdgGate). -`SGate.power(exponent)` +`SGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.SXGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.SXGate.md index d156bcd4e87..1ee0a76c765 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.SXGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.SXGate --- -# SXGate[¶](#sxgate "Permalink to this headline") +# SXGate -`SXGate(label=None)` +`SXGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -55,7 +55,7 @@ Create new SX gate. -`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`SXGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Return a (multi-)controlled-SX gate. @@ -79,7 +79,7 @@ controlled version of this gate. -`SXGate.inverse()` +`SXGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SX gate (i.e. SXdg). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.SXdgGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.SXdgGate.md index 101f0bf621e..ebdf3a8770e 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.SXdgGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.SXdgGate --- -# SXdgGate[¶](#sxdggate "Permalink to this headline") +# SXdgGate -`SXdgGate(label=None)` +`SXdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -45,7 +45,7 @@ Create new SXdg gate. -`SXdgGate.inverse()` +`SXdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/sx.py "view source code") Return inverse SXdg gate (i.e. SX). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.SdgGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.SdgGate.md index 3c2166ab6ff..dd7732f601d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.SdgGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.SdgGate --- -# SdgGate[¶](#sdggate "Permalink to this headline") +# SdgGate -`SdgGate(label=None)` +`SdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new Sdg gate. -`SdgGate.inverse()` +`SdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Return inverse of Sdg (SGate). @@ -57,7 +57,7 @@ Return inverse of Sdg (SGate). -`SdgGate.power(exponent)` +`SdgGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/s.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.StatePreparation.md b/docs/api/qiskit/0.41/qiskit.circuit.library.StatePreparation.md index e10ebe6a096..7b5aa7feaa8 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.StatePreparation.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.StatePreparation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.StatePreparation --- -# StatePreparation[¶](#statepreparation "Permalink to this headline") +# StatePreparation -`StatePreparation(params, num_qubits=None, inverse=False, label=None)` +`StatePreparation(params, num_qubits=None, inverse=False, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -47,7 +47,7 @@ When a Statevector argument is passed the state is prepared using a recursive in -`StatePreparation.broadcast_arguments(qargs, cargs)` +`StatePreparation.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Validation and handling of the arguments and its relationship. @@ -98,7 +98,7 @@ A tuple with single arguments. -`StatePreparation.inverse()` +`StatePreparation.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") Return inverted StatePreparation @@ -106,7 +106,7 @@ Return inverted StatePreparation -`StatePreparation.validate_parameter(parameter)` +`StatePreparation.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/state_preparation.py "view source code") StatePreparation instruction parameter can be str, int, float, and complex. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.SwapGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.SwapGate.md index d5b7b2a7469..e700f960e4d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.SwapGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.SwapGate --- -# SwapGate[¶](#swapgate "Permalink to this headline") +# SwapGate -`SwapGate(label=None)` +`SwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -54,7 +54,7 @@ Create new SWAP gate. -`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`SwapGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Return a (multi-)controlled-SWAP gate. @@ -78,7 +78,7 @@ controlled version of this gate. -`SwapGate.inverse()` +`SwapGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/swap.py "view source code") Return inverse Swap gate (itself). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.TGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.TGate.md index 5f9b10db362..bbddfdff0f2 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.TGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.TGate --- -# TGate[¶](#tgate "Permalink to this headline") +# TGate -`TGate(label=None)` +`TGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new T gate. -`TGate.inverse()` +`TGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse T gate (i.e. Tdg). @@ -57,7 +57,7 @@ Return inverse T gate (i.e. Tdg). -`TGate.power(exponent)` +`TGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.TdgGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.TdgGate.md index 5e89eb441f1..ce83234bf4b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.TdgGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.TdgGate --- -# TdgGate[¶](#tdggate "Permalink to this headline") +# TdgGate -`TdgGate(label=None)` +`TdgGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -49,7 +49,7 @@ Create new Tdg gate. -`TdgGate.inverse()` +`TdgGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Return inverse Tdg gate (i.e. T). @@ -57,7 +57,7 @@ Return inverse Tdg gate (i.e. T). -`TdgGate.power(exponent)` +`TdgGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/t.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.TwoLocal.md b/docs/api/qiskit/0.41/qiskit.circuit.library.TwoLocal.md index 01eb21e74eb..30079001aac 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.TwoLocal.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.TwoLocal --- -# TwoLocal[¶](#twolocal "Permalink to this headline") +# TwoLocal -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')` +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: [`qiskit.circuit.library.n_local.n_local.NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.n_local.n_local.NLocal") @@ -134,7 +134,7 @@ Construct a new two-local circuit. -`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)` +`TwoLocal.get_entangler_map(rep_num, block_num, num_block_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/n_local/two_local.py "view source code") Overloading to handle the special case of 1 qubit where the entanglement are ignored. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.U1Gate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.U1Gate.md index f75a284671b..0fcc929f76b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.U1Gate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.U1Gate --- -# U1Gate[¶](#u1gate "Permalink to this headline") +# U1Gate -`U1Gate(theta, label=None)` +`U1Gate(theta, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -83,7 +83,7 @@ Create new U1 gate. -`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`U1Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Return a (multi-)controlled-U1 gate. @@ -105,7 +105,7 @@ controlled version of this gate. -`U1Gate.inverse()` +`U1Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u1.py "view source code") Return inverted U1 gate ($U1(\lambda){\dagger} = U1(-\lambda)$) diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.U2Gate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.U2Gate.md index 773a2c6f837..8dbe6a07d67 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.U2Gate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.U2Gate --- -# U2Gate[¶](#u2gate "Permalink to this headline") +# U2Gate -`U2Gate(phi, lam, label=None)` +`U2Gate(phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u2.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -82,7 +82,7 @@ Create new U2 gate. -`U2Gate.inverse()` +`U2Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u2.py "view source code") Return inverted U2 gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.U3Gate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.U3Gate.md index 74d73b6875f..a69aa7d5aed 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.U3Gate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.U3Gate --- -# U3Gate[¶](#u3gate "Permalink to this headline") +# U3Gate -`U3Gate(theta, phi, lam, label=None)` +`U3Gate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -74,7 +74,7 @@ Create new U3 gate. -`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`U3Gate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Return a (multi-)controlled-U3 gate. @@ -96,7 +96,7 @@ controlled version of this gate. -`U3Gate.inverse()` +`U3Gate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u3.py "view source code") Return inverted U3 gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.UGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.UGate.md index 498cd26f46b..16f8b8d2daf 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.UGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.UGate --- -# UGate[¶](#ugate "Permalink to this headline") +# UGate -`UGate(theta, phi, lam, label=None)` +`UGate(theta, phi, lam, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -58,7 +58,7 @@ Create new U gate. -`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`UGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Return a (multi-)controlled-U gate. @@ -80,7 +80,7 @@ controlled version of this gate. -`UGate.inverse()` +`UGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/u.py "view source code") Return inverted U gate. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.VBERippleCarryAdder.md b/docs/api/qiskit/0.41/qiskit.circuit.library.VBERippleCarryAdder.md index 33e6382c5b5..2d724aaf226 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.VBERippleCarryAdder.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.VBERippleCarryAdder --- -# VBERippleCarryAdder[¶](#vberipplecarryadder "Permalink to this headline") +# VBERippleCarryAdder -`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` +`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.WeightedAdder.md b/docs/api/qiskit/0.41/qiskit.circuit.library.WeightedAdder.md index 3420a696aee..0cf66bf3077 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.WeightedAdder.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.WeightedAdder --- -# WeightedAdder[¶](#weightedadder "Permalink to this headline") +# WeightedAdder -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.XGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.XGate.md index a7a38e0c80a..d6e2b1195cf 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.XGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.XGate --- -# XGate[¶](#xgate "Permalink to this headline") +# XGate -`XGate(label=None)` +`XGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new X gate. -`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`XGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return a (multi-)controlled-X gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`XGate.inverse()` +`XGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/x.py "view source code") Return inverted X gate (itself). diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.XOR.md b/docs/api/qiskit/0.41/qiskit.circuit.library.XOR.md index d4012fa5bc0..8b17c296f8c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.XOR.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.XOR --- -# XOR[¶](#xor "Permalink to this headline") +# XOR -`XOR(num_qubits, amount=None, seed=None)` +`XOR(num_qubits, amount=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/boolean_logic/quantum_xor.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.XXMinusYYGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.XXMinusYYGate.md index 9a666644933..d378f67a9b6 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.XXMinusYYGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.XXMinusYYGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.XXMinusYYGate --- -# XXMinusYYGate[¶](#xxminusyygate "Permalink to this headline") +# XXMinusYYGate -`XXMinusYYGate(theta, beta=0, label='{XX-YY}')` +`XXMinusYYGate(theta, beta=0, label='{XX-YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -78,7 +78,7 @@ Create new XX-YY gate. -`XXMinusYYGate.inverse()` +`XXMinusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Inverse gate. @@ -86,7 +86,7 @@ Inverse gate. -`XXMinusYYGate.power(exponent)` +`XXMinusYYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_minus_yy.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.XXPlusYYGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.XXPlusYYGate.md index cb0cdd812fe..ac25436d40a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.XXPlusYYGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.XXPlusYYGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.XXPlusYYGate --- -# XXPlusYYGate[¶](#xxplusyygate "Permalink to this headline") +# XXPlusYYGate -`XXPlusYYGate(theta, beta=0, label='{XX+YY}')` +`XXPlusYYGate(theta, beta=0, label='{XX+YY}')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -78,7 +78,7 @@ Create new XX+YY gate. -`XXPlusYYGate.inverse()` +`XXPlusYYGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Return inverse XX+YY gate (i.e. with the negative rotation angle and same phase angle). @@ -86,7 +86,7 @@ Return inverse XX+YY gate (i.e. with the negative rotation angle and same phase -`XXPlusYYGate.power(exponent)` +`XXPlusYYGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/xx_plus_yy.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.YGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.YGate.md index 30f15f94dcb..8f4f8a2e5f7 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.YGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.YGate --- -# YGate[¶](#ygate "Permalink to this headline") +# YGate -`YGate(label=None)` +`YGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new Y gate. -`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`YGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Return a (multi-)controlled-Y gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`YGate.inverse()` +`YGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/y.py "view source code") Return inverted Y gate ($Y{\dagger} = Y$) diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.ZFeatureMap.md b/docs/api/qiskit/0.41/qiskit.circuit.library.ZFeatureMap.md index ae419f8d1e5..5ee835ae550 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.ZFeatureMap.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.ZFeatureMap --- -# ZFeatureMap[¶](#zfeaturemap "Permalink to this headline") +# ZFeatureMap -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')` +`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/z_feature_map.py "view source code") Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.ZGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.ZGate.md index eaa462c6d61..bcc47dc0d31 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.ZGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.ZGate --- -# ZGate[¶](#zgate "Permalink to this headline") +# ZGate -`ZGate(label=None)` +`ZGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -64,7 +64,7 @@ Create new Z gate. -`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`ZGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Return a (multi-)controlled-Z gate. @@ -88,7 +88,7 @@ controlled version of this gate. -`ZGate.inverse()` +`ZGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Return inverted Z gate (itself). @@ -96,7 +96,7 @@ Return inverted Z gate (itself). -`ZGate.power(exponent)` +`ZGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/z.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.ZZFeatureMap.md b/docs/api/qiskit/0.41/qiskit.circuit.library.ZZFeatureMap.md index 9602f5d4023..3fac40a9136 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.ZZFeatureMap.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.ZZFeatureMap --- -# ZZFeatureMap[¶](#zzfeaturemap "Permalink to this headline") +# ZZFeatureMap -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')` +`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, parameter_prefix='x', insert_barriers=False, name='ZZFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/data_preparation/zz_feature_map.py "view source code") Bases: [`qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap") diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_1.md index 89b0617215b..537a2592732 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.clifford_2_1 --- -# qiskit.circuit.library.clifford\_2\_1[¶](#qiskit-circuit-library-clifford-2-1 "Permalink to this headline") +# qiskit.circuit.library.clifford\_2\_1 -`clifford_2_1()` +`clifford_2_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_2.md index 55cfb81adc5..cbc054b1f73 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_2.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.clifford_2_2 --- -# qiskit.circuit.library.clifford\_2\_2[¶](#qiskit-circuit-library-clifford-2-2 "Permalink to this headline") +# qiskit.circuit.library.clifford\_2\_2 -`clifford_2_2()` +`clifford_2_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_3.md index 66dbda9060e..4067d4099cf 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_3.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.clifford_2_3 --- -# qiskit.circuit.library.clifford\_2\_3[¶](#qiskit-circuit-library-clifford-2-3 "Permalink to this headline") +# qiskit.circuit.library.clifford\_2\_3 -`clifford_2_3()` +`clifford_2_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_4.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_4.md index e24bca9bce2..df5a5b13f6a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_4.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_2_4.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.clifford_2_4 --- -# qiskit.circuit.library.clifford\_2\_4[¶](#qiskit-circuit-library-clifford-2-4 "Permalink to this headline") +# qiskit.circuit.library.clifford\_2\_4 -`clifford_2_4()` +`clifford_2_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_2_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_3_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_3_1.md index a506e4ca091..d6dab2fc07a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_3_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_3_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.clifford_3_1 --- -# qiskit.circuit.library.clifford\_3\_1[¶](#qiskit-circuit-library-clifford-3-1 "Permalink to this headline") +# qiskit.circuit.library.clifford\_3\_1 -`clifford_3_1()` +`clifford_3_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_3_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_1.md index 0d15ce5b7c5..e5cb97250c1 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.clifford_4_1 --- -# qiskit.circuit.library.clifford\_4\_1[¶](#qiskit-circuit-library-clifford-4-1 "Permalink to this headline") +# qiskit.circuit.library.clifford\_4\_1 -`clifford_4_1()` +`clifford_4_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_2.md index 1565aca9336..57c4ffbdf9b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_2.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.clifford_4_2 --- -# qiskit.circuit.library.clifford\_4\_2[¶](#qiskit-circuit-library-clifford-4-2 "Permalink to this headline") +# qiskit.circuit.library.clifford\_4\_2 -`clifford_4_2()` +`clifford_4_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_3.md index 4660fe6cd60..11c7d5cd0e2 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_3.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.clifford_4_3 --- -# qiskit.circuit.library.clifford\_4\_3[¶](#qiskit-circuit-library-clifford-4-3 "Permalink to this headline") +# qiskit.circuit.library.clifford\_4\_3 -`clifford_4_3()` +`clifford_4_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_4.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_4.md index 42c20f77ea3..5eafc0a0abe 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_4.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_4_4.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.clifford_4_4 --- -# qiskit.circuit.library.clifford\_4\_4[¶](#qiskit-circuit-library-clifford-4-4 "Permalink to this headline") +# qiskit.circuit.library.clifford\_4\_4 -`clifford_4_4()` +`clifford_4_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_4_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_5_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_5_1.md index 1809aa567f6..4838b2afc26 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_5_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_5_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.clifford_5_1 --- -# qiskit.circuit.library.clifford\_5\_1[¶](#qiskit-circuit-library-clifford-5-1 "Permalink to this headline") +# qiskit.circuit.library.clifford\_5\_1 -`clifford_5_1()` +`clifford_5_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_5_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_1.md index 35dca202da3..0f730a0a850 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.clifford_6_1 --- -# qiskit.circuit.library.clifford\_6\_1[¶](#qiskit-circuit-library-clifford-6-1 "Permalink to this headline") +# qiskit.circuit.library.clifford\_6\_1 -`clifford_6_1()` +`clifford_6_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_2.md index 4b58b1603d2..32481500c09 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_2.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.clifford_6_2 --- -# qiskit.circuit.library.clifford\_6\_2[¶](#qiskit-circuit-library-clifford-6-2 "Permalink to this headline") +# qiskit.circuit.library.clifford\_6\_2 -`clifford_6_2()` +`clifford_6_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_3.md index 1216a0885c8..f4c16715bca 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_3.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.clifford_6_3 --- -# qiskit.circuit.library.clifford\_6\_3[¶](#qiskit-circuit-library-clifford-6-3 "Permalink to this headline") +# qiskit.circuit.library.clifford\_6\_3 -`clifford_6_3()` +`clifford_6_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_4.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_4.md index 2227c9c5963..f13175b19b8 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_4.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_4.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.clifford_6_4 --- -# qiskit.circuit.library.clifford\_6\_4[¶](#qiskit-circuit-library-clifford-6-4 "Permalink to this headline") +# qiskit.circuit.library.clifford\_6\_4 -`clifford_6_4()` +`clifford_6_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_5.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_5.md index cc80f7a15cb..b4e83cd6f30 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_5.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_6_5.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.clifford_6_5 --- -# qiskit.circuit.library.clifford\_6\_5[¶](#qiskit-circuit-library-clifford-6-5 "Permalink to this headline") +# qiskit.circuit.library.clifford\_6\_5 -`clifford_6_5()` +`clifford_6_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_6_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_1.md index fa5136a037e..5db991f3aaa 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.clifford_8_1 --- -# qiskit.circuit.library.clifford\_8\_1[¶](#qiskit-circuit-library-clifford-8-1 "Permalink to this headline") +# qiskit.circuit.library.clifford\_8\_1 -`clifford_8_1()` +`clifford_8_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_2.md index 754e90bcdd2..3509d7227e8 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_2.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.clifford_8_2 --- -# qiskit.circuit.library.clifford\_8\_2[¶](#qiskit-circuit-library-clifford-8-2 "Permalink to this headline") +# qiskit.circuit.library.clifford\_8\_2 -`clifford_8_2()` +`clifford_8_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_3.md index 0cdf510dbb6..92a08eaa2a4 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.clifford_8_3.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.clifford_8_3 --- -# qiskit.circuit.library.clifford\_8\_3[¶](#qiskit-circuit-library-clifford-8-3 "Permalink to this headline") +# qiskit.circuit.library.clifford\_8\_3 -`clifford_8_3()` +`clifford_8_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/clifford/clifford_8_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.iSwapGate.md b/docs/api/qiskit/0.41/qiskit.circuit.library.iSwapGate.md index b74f62faddf..4d3b6311a5f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.iSwapGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.circuit.library.iSwapGate --- -# iSwapGate[¶](#iswapgate "Permalink to this headline") +# iSwapGate -`iSwapGate(label=None)` +`iSwapGate(label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/iswap.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -77,7 +77,7 @@ Create new iSwap gate. -`iSwapGate.power(exponent)` +`iSwapGate.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/standard_gates/iswap.py "view source code") Raise gate to a power. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_cy.md b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_cy.md index 71d517d8ac4..2e7c58db696 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_cy.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_cy.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.rzx_cy --- -# qiskit.circuit.library.rzx\_cy[¶](#qiskit-circuit-library-rzx-cy "Permalink to this headline") +# qiskit.circuit.library.rzx\_cy -`rzx_cy(theta=None)` +`rzx_cy(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_cy.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_xz.md b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_xz.md index 6cb2241db00..dc512e4fad5 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_xz.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_xz.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.rzx_xz --- -# qiskit.circuit.library.rzx\_xz[¶](#qiskit-circuit-library-rzx-xz "Permalink to this headline") +# qiskit.circuit.library.rzx\_xz -`rzx_xz(theta=None)` +`rzx_xz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_xz.py "view source code") Template for CX - RXGate - CX. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_yz.md b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_yz.md index 616e23de8ae..b430c7c7605 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_yz.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_yz.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.rzx_yz --- -# qiskit.circuit.library.rzx\_yz[¶](#qiskit-circuit-library-rzx-yz "Permalink to this headline") +# qiskit.circuit.library.rzx\_yz -`rzx_yz(theta=None)` +`rzx_yz(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_yz.py "view source code") Template for CX - RYGate - CX. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz1.md index 057736d3bbd..f6d631f440c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.rzx_zz1 --- -# qiskit.circuit.library.rzx\_zz1[¶](#qiskit-circuit-library-rzx-zz1 "Permalink to this headline") +# qiskit.circuit.library.rzx\_zz1 -`rzx_zz1(theta=None)` +`rzx_zz1(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz1.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz2.md index 4fe8a9db8d9..8ddfd743be2 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz2.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.rzx_zz2 --- -# qiskit.circuit.library.rzx\_zz2[¶](#qiskit-circuit-library-rzx-zz2 "Permalink to this headline") +# qiskit.circuit.library.rzx\_zz2 -`rzx_zz2(theta=None)` +`rzx_zz2(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz2.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz3.md index 7e790b7fed3..4658b8ba613 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.rzx_zz3.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.rzx_zz3 --- -# qiskit.circuit.library.rzx\_zz3[¶](#qiskit-circuit-library-rzx-zz3 "Permalink to this headline") +# qiskit.circuit.library.rzx\_zz3 -`rzx_zz3(theta=None)` +`rzx_zz3(theta=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/rzx/rzx_zz3.py "view source code") Template for CX - RZGate - CX. diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_1.md index 5445a1dc487..411cc2785bd 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 --- -# qiskit.circuit.library.templates.nct.template\_nct\_2a\_1[¶](#qiskit-circuit-library-templates-nct-template-nct-2a-1 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_2a\_1 -`template_nct_2a_1()` +`template_nct_2a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_2.md index 4d5793c799a..d4658054174 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_2.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 --- -# qiskit.circuit.library.templates.nct.template\_nct\_2a\_2[¶](#qiskit-circuit-library-templates-nct-template-nct-2a-2 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_2a\_2 -`template_nct_2a_2()` +`template_nct_2a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_3.md index 42ddf65801f..523b9ca1ee1 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_2a_3.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 --- -# qiskit.circuit.library.templates.nct.template\_nct\_2a\_3[¶](#qiskit-circuit-library-templates-nct-template-nct-2a-3 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_2a\_3 -`template_nct_2a_3()` +`template_nct_2a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_2a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_1.md index c04a122b38b..ba9d086e738 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 --- -# qiskit.circuit.library.templates.nct.template\_nct\_4a\_1[¶](#qiskit-circuit-library-templates-nct-template-nct-4a-1 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_4a\_1 -`template_nct_4a_1()` +`template_nct_4a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_2.md index 84b7b1748a2..97efbb86e96 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_2.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 --- -# qiskit.circuit.library.templates.nct.template\_nct\_4a\_2[¶](#qiskit-circuit-library-templates-nct-template-nct-4a-2 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_4a\_2 -`template_nct_4a_2()` +`template_nct_4a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_3.md index b63ccec568c..dcfb88a2083 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4a_3.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 --- -# qiskit.circuit.library.templates.nct.template\_nct\_4a\_3[¶](#qiskit-circuit-library-templates-nct-template-nct-4a-3 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_4a\_3 -`template_nct_4a_3()` +`template_nct_4a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4b_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4b_1.md index 419a2c7fb32..eb681b27915 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4b_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4b_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 --- -# qiskit.circuit.library.templates.nct.template\_nct\_4b\_1[¶](#qiskit-circuit-library-templates-nct-template-nct-4b-1 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_4b\_1 -`template_nct_4b_1()` +`template_nct_4b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4b_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4b_2.md index ef35863a132..7716596b8c7 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4b_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_4b_2.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 --- -# qiskit.circuit.library.templates.nct.template\_nct\_4b\_2[¶](#qiskit-circuit-library-templates-nct-template-nct-4b-2 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_4b\_2 -`template_nct_4b_2()` +`template_nct_4b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_4b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_1.md index af7016c1f86..2030aff311c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 --- -# qiskit.circuit.library.templates.nct.template\_nct\_5a\_1[¶](#qiskit-circuit-library-templates-nct-template-nct-5a-1 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_5a\_1 -`template_nct_5a_1()` +`template_nct_5a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_2.md index de4d947f4c4..4f995a87f7e 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_2.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 --- -# qiskit.circuit.library.templates.nct.template\_nct\_5a\_2[¶](#qiskit-circuit-library-templates-nct-template-nct-5a-2 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_5a\_2 -`template_nct_5a_2()` +`template_nct_5a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_3.md index 21eba8d7502..63d67446d01 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_3.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 --- -# qiskit.circuit.library.templates.nct.template\_nct\_5a\_3[¶](#qiskit-circuit-library-templates-nct-template-nct-5a-3 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_5a\_3 -`template_nct_5a_3()` +`template_nct_5a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_4.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_4.md index 3f4b879614d..d3feffedd4a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_4.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_5a_4.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 --- -# qiskit.circuit.library.templates.nct.template\_nct\_5a\_4[¶](#qiskit-circuit-library-templates-nct-template-nct-5a-4 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_5a\_4 -`template_nct_5a_4()` +`template_nct_5a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_5a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_1.md index 28150cada01..d5df5a4840d 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 --- -# qiskit.circuit.library.templates.nct.template\_nct\_6a\_1[¶](#qiskit-circuit-library-templates-nct-template-nct-6a-1 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_6a\_1 -`template_nct_6a_1()` +`template_nct_6a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_2.md index 9ecb0932cf6..f6ceda17a34 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_2.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 --- -# qiskit.circuit.library.templates.nct.template\_nct\_6a\_2[¶](#qiskit-circuit-library-templates-nct-template-nct-6a-2 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_6a\_2 -`template_nct_6a_2()` +`template_nct_6a_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_3.md index dcd5b1b44cc..3c69aeb9710 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_3.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 --- -# qiskit.circuit.library.templates.nct.template\_nct\_6a\_3[¶](#qiskit-circuit-library-templates-nct-template-nct-6a-3 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_6a\_3 -`template_nct_6a_3()` +`template_nct_6a_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_4.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_4.md index 8fa56d98d36..28c6c50f977 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_4.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6a_4.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 --- -# qiskit.circuit.library.templates.nct.template\_nct\_6a\_4[¶](#qiskit-circuit-library-templates-nct-template-nct-6a-4 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_6a\_4 -`template_nct_6a_4()` +`template_nct_6a_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6a_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6b_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6b_1.md index 36308145b80..e9ace7e9516 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6b_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6b_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 --- -# qiskit.circuit.library.templates.nct.template\_nct\_6b\_1[¶](#qiskit-circuit-library-templates-nct-template-nct-6b-1 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_6b\_1 -`template_nct_6b_1()` +`template_nct_6b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6b_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6b_2.md index dd0027bf02f..a7b7b028d63 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6b_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6b_2.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 --- -# qiskit.circuit.library.templates.nct.template\_nct\_6b\_2[¶](#qiskit-circuit-library-templates-nct-template-nct-6b-2 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_6b\_2 -`template_nct_6b_2()` +`template_nct_6b_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6b_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6c_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6c_1.md index 03d776d6a1d..101eb025fac 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6c_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_6c_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 --- -# qiskit.circuit.library.templates.nct.template\_nct\_6c\_1[¶](#qiskit-circuit-library-templates-nct-template-nct-6c-1 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_6c\_1 -`template_nct_6c_1()` +`template_nct_6c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_6c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7a_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7a_1.md index 1043b1f547b..0b99372f4f1 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7a_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7a_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 --- -# qiskit.circuit.library.templates.nct.template\_nct\_7a\_1[¶](#qiskit-circuit-library-templates-nct-template-nct-7a-1 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_7a\_1 -`template_nct_7a_1()` +`template_nct_7a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7b_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7b_1.md index d116061b1ba..063a1019dd8 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7b_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7b_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 --- -# qiskit.circuit.library.templates.nct.template\_nct\_7b\_1[¶](#qiskit-circuit-library-templates-nct-template-nct-7b-1 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_7b\_1 -`template_nct_7b_1()` +`template_nct_7b_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7b_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7c_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7c_1.md index bb04614501f..a9450c13fb0 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7c_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7c_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 --- -# qiskit.circuit.library.templates.nct.template\_nct\_7c\_1[¶](#qiskit-circuit-library-templates-nct-template-nct-7c-1 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_7c\_1 -`template_nct_7c_1()` +`template_nct_7c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7d_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7d_1.md index 3325f0cc5ff..57f5f89602e 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7d_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7d_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 --- -# qiskit.circuit.library.templates.nct.template\_nct\_7d\_1[¶](#qiskit-circuit-library-templates-nct-template-nct-7d-1 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_7d\_1 -`template_nct_7d_1()` +`template_nct_7d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7e_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7e_1.md index c89cb20c184..7add567d79f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7e_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_7e_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 --- -# qiskit.circuit.library.templates.nct.template\_nct\_7e\_1[¶](#qiskit-circuit-library-templates-nct-template-nct-7e-1 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_7e\_1 -`template_nct_7e_1()` +`template_nct_7e_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_7e_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9a_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9a_1.md index 98ff22cef80..4d21f1ecea0 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9a_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9a_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9a\_1[¶](#qiskit-circuit-library-templates-nct-template-nct-9a-1 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9a\_1 -`template_nct_9a_1()` +`template_nct_9a_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9a_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_1.md index 522d9e13cfb..912f691818a 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_1[¶](#qiskit-circuit-library-templates-nct-template-nct-9c-1 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_1 -`template_nct_9c_1()` +`template_nct_9c_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_10.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_10.md index 9eb44d8748e..b14c7c34ad1 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_10.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_10.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_10[¶](#qiskit-circuit-library-templates-nct-template-nct-9c-10 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_10 -`template_nct_9c_10()` +`template_nct_9c_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_11.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_11.md index a204a5fae37..190aaf00371 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_11.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_11.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_11[¶](#qiskit-circuit-library-templates-nct-template-nct-9c-11 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_11 -`template_nct_9c_11()` +`template_nct_9c_11()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_11.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_12.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_12.md index e88f6aebdc7..6d8196a357f 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_12.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_12.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_12[¶](#qiskit-circuit-library-templates-nct-template-nct-9c-12 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_12 -`template_nct_9c_12()` +`template_nct_9c_12()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_12.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_2.md index 5905c1192b3..6e8b04ad1e3 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_2.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_2[¶](#qiskit-circuit-library-templates-nct-template-nct-9c-2 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_2 -`template_nct_9c_2()` +`template_nct_9c_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_3.md index 42013992e49..cb3aae6bda2 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_3.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_3[¶](#qiskit-circuit-library-templates-nct-template-nct-9c-3 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_3 -`template_nct_9c_3()` +`template_nct_9c_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_4.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_4.md index 36c4e4b34b9..1a502f14d60 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_4.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_4.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_4[¶](#qiskit-circuit-library-templates-nct-template-nct-9c-4 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_4 -`template_nct_9c_4()` +`template_nct_9c_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_5.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_5.md index e6d4cca9662..01cbe2f3259 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_5.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_5.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_5[¶](#qiskit-circuit-library-templates-nct-template-nct-9c-5 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_5 -`template_nct_9c_5()` +`template_nct_9c_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_6.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_6.md index cc41e8c6d59..55191519877 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_6.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_6.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_6[¶](#qiskit-circuit-library-templates-nct-template-nct-9c-6 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_6 -`template_nct_9c_6()` +`template_nct_9c_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_7.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_7.md index c6f47d51d3b..3e604d8aae5 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_7.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_7.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_7[¶](#qiskit-circuit-library-templates-nct-template-nct-9c-7 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_7 -`template_nct_9c_7()` +`template_nct_9c_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_8.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_8.md index 8168026d99b..d755e41e8c5 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_8.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_8.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_8[¶](#qiskit-circuit-library-templates-nct-template-nct-9c-8 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_8 -`template_nct_9c_8()` +`template_nct_9c_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_9.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_9.md index e733784c082..7db3309ec76 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_9.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9c_9.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_9[¶](#qiskit-circuit-library-templates-nct-template-nct-9c-9 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_9 -`template_nct_9c_9()` +`template_nct_9c_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9c_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_1.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_1.md index 0eccafcd917..640bdd2e40b 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_1.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_1[¶](#qiskit-circuit-library-templates-nct-template-nct-9d-1 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_1 -`template_nct_9d_1()` +`template_nct_9d_1()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_1.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_10.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_10.md index bf3416b20b9..4f16e108b89 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_10.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_10.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_10[¶](#qiskit-circuit-library-templates-nct-template-nct-9d-10 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_10 -`template_nct_9d_10()` +`template_nct_9d_10()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_10.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_2.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_2.md index ba0f4ea957f..95efa766d85 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_2.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_2.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_2[¶](#qiskit-circuit-library-templates-nct-template-nct-9d-2 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_2 -`template_nct_9d_2()` +`template_nct_9d_2()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_2.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_3.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_3.md index 0dc2cb6c929..9547a53343c 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_3.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_3.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_3[¶](#qiskit-circuit-library-templates-nct-template-nct-9d-3 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_3 -`template_nct_9d_3()` +`template_nct_9d_3()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_3.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_4.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_4.md index cde9029d503..230d5ad3387 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_4.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_4.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_4[¶](#qiskit-circuit-library-templates-nct-template-nct-9d-4 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_4 -`template_nct_9d_4()` +`template_nct_9d_4()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_4.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_5.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_5.md index 99e3355bf8e..9e2d4cbe7e4 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_5.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_5.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_5[¶](#qiskit-circuit-library-templates-nct-template-nct-9d-5 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_5 -`template_nct_9d_5()` +`template_nct_9d_5()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_5.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_6.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_6.md index 506f88ace35..cf0ffb26b11 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_6.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_6.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_6[¶](#qiskit-circuit-library-templates-nct-template-nct-9d-6 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_6 -`template_nct_9d_6()` +`template_nct_9d_6()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_6.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_7.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_7.md index d523697e165..b59fe428856 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_7.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_7.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_7[¶](#qiskit-circuit-library-templates-nct-template-nct-9d-7 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_7 -`template_nct_9d_7()` +`template_nct_9d_7()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_7.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_8.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_8.md index 6728f08b2d6..f05dbd7d8b5 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_8.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_8.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_8[¶](#qiskit-circuit-library-templates-nct-template-nct-9d-8 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_8 -`template_nct_9d_8()` +`template_nct_9d_8()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_8.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_9.md b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_9.md index 3e2e11ffe21..da1c5d8c7d5 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_9.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.library.templates.nct.template_nct_9d_9.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 --- -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_9[¶](#qiskit-circuit-library-templates-nct-template-nct-9d-9 "Permalink to this headline") +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_9 -`template_nct_9d_9()` +`template_nct_9d_9()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/library/templates/nct/template_nct_9d_9.py "view source code") **Returns** diff --git a/docs/api/qiskit/0.41/qiskit.circuit.random.random_circuit.md b/docs/api/qiskit/0.41/qiskit.circuit.random.random_circuit.md index 8f02d15f923..adef361e2ea 100644 --- a/docs/api/qiskit/0.41/qiskit.circuit.random.random_circuit.md +++ b/docs/api/qiskit/0.41/qiskit.circuit.random.random_circuit.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.circuit.random.random_circuit --- -# qiskit.circuit.random.random\_circuit[¶](#qiskit-circuit-random-random-circuit "Permalink to this headline") +# qiskit.circuit.random.random\_circuit -`random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)` +`random_circuit(num_qubits, depth, max_operands=4, measure=False, conditional=False, reset=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/circuit/random/utils.py "view source code") Generate random circuit of arbitrary size and form. diff --git a/docs/api/qiskit/0.41/qiskit.compiler.assemble.md b/docs/api/qiskit/0.41/qiskit.compiler.assemble.md index dd116657401..7e6785ebf9b 100644 --- a/docs/api/qiskit/0.41/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.41/qiskit.compiler.assemble.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.compiler.assemble --- -# qiskit.compiler.assemble[¶](#qiskit-compiler-assemble "Permalink to this headline") +# qiskit.compiler.assemble -`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)` +`assemble(experiments, backend=None, qobj_id=None, qobj_header=None, shots=None, memory=False, max_credits=None, seed_simulator=None, qubit_lo_freq=None, meas_lo_freq=None, qubit_lo_range=None, meas_lo_range=None, schedule_los=None, meas_level=MeasLevel.CLASSIFIED, meas_return=MeasReturnType.AVERAGE, meas_map=None, memory_slot_size=100, rep_time=None, rep_delay=None, parameter_binds=None, parametric_pulses=None, init_qubits=True, **run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/assembler.py "view source code") Assemble a list of circuits or pulse schedules into a `Qobj`. diff --git a/docs/api/qiskit/0.41/qiskit.compiler.schedule.md b/docs/api/qiskit/0.41/qiskit.compiler.schedule.md index f7964c47b43..2a8358979da 100644 --- a/docs/api/qiskit/0.41/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.41/qiskit.compiler.schedule.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.compiler.schedule --- -# qiskit.compiler.schedule[¶](#qiskit-compiler-schedule "Permalink to this headline") +# qiskit.compiler.schedule -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/scheduler.py "view source code") Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. Supported methods are documented in [`qiskit.scheduler.schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit"). diff --git a/docs/api/qiskit/0.41/qiskit.compiler.sequence.md b/docs/api/qiskit/0.41/qiskit.compiler.sequence.md index 683d0f88bdd..46db9f61083 100644 --- a/docs/api/qiskit/0.41/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.41/qiskit.compiler.sequence.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.compiler.sequence --- -# qiskit.compiler.sequence[¶](#qiskit-compiler-sequence "Permalink to this headline") +# qiskit.compiler.sequence -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. diff --git a/docs/api/qiskit/0.41/qiskit.compiler.transpile.md b/docs/api/qiskit/0.41/qiskit.compiler.transpile.md index 72d4c034a84..0e4a3bcc7d8 100644 --- a/docs/api/qiskit/0.41/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.41/qiskit.compiler.transpile.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.compiler.transpile --- -# qiskit.compiler.transpile[¶](#qiskit-compiler-transpile "Permalink to this headline") +# qiskit.compiler.transpile -`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)` +`transpile(circuits, backend=None, basis_gates=None, inst_map=None, coupling_map=None, backend_properties=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, dt=None, approximation_degree=1.0, timing_constraints=None, seed_transpiler=None, optimization_level=None, callback=None, output_name=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None, ignore_backend_supplied_default_methods=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/compiler/transpiler.py "view source code") Transpile one or more circuits, according to some desired transpilation targets. diff --git a/docs/api/qiskit/0.41/qiskit.converters.ast_to_dag.md b/docs/api/qiskit/0.41/qiskit.converters.ast_to_dag.md index 8bb7dd18195..1670f91ba34 100644 --- a/docs/api/qiskit/0.41/qiskit.converters.ast_to_dag.md +++ b/docs/api/qiskit/0.41/qiskit.converters.ast_to_dag.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.converters.ast_to_dag --- -# qiskit.converters.ast\_to\_dag[¶](#qiskit-converters-ast-to-dag "Permalink to this headline") +# qiskit.converters.ast\_to\_dag -`ast_to_dag(ast)` +`ast_to_dag(ast)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/ast_to_dag.py "view source code") Build a `DAGCircuit` object from an AST `Node` object. diff --git a/docs/api/qiskit/0.41/qiskit.converters.circuit_to_dag.md b/docs/api/qiskit/0.41/qiskit.converters.circuit_to_dag.md index 349342e999b..d8cac5a7866 100644 --- a/docs/api/qiskit/0.41/qiskit.converters.circuit_to_dag.md +++ b/docs/api/qiskit/0.41/qiskit.converters.circuit_to_dag.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.converters.circuit_to_dag --- -# qiskit.converters.circuit\_to\_dag[¶](#qiskit-converters-circuit-to-dag "Permalink to this headline") +# qiskit.converters.circuit\_to\_dag -`circuit_to_dag(circuit)` +`circuit_to_dag(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_dag.py "view source code") Build a `DAGCircuit` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.41/qiskit.converters.circuit_to_dagdependency.md b/docs/api/qiskit/0.41/qiskit.converters.circuit_to_dagdependency.md index e64df005489..1e567ee1a25 100644 --- a/docs/api/qiskit/0.41/qiskit.converters.circuit_to_dagdependency.md +++ b/docs/api/qiskit/0.41/qiskit.converters.circuit_to_dagdependency.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.converters.circuit_to_dagdependency --- -# qiskit.converters.circuit\_to\_dagdependency[¶](#qiskit-converters-circuit-to-dagdependency "Permalink to this headline") +# qiskit.converters.circuit\_to\_dagdependency -`circuit_to_dagdependency(circuit, create_preds_and_succs=True)` +`circuit_to_dagdependency(circuit, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `QuantumCircuit`. diff --git a/docs/api/qiskit/0.41/qiskit.converters.circuit_to_gate.md b/docs/api/qiskit/0.41/qiskit.converters.circuit_to_gate.md index 004e65cdcd6..dca1b2e68d8 100644 --- a/docs/api/qiskit/0.41/qiskit.converters.circuit_to_gate.md +++ b/docs/api/qiskit/0.41/qiskit.converters.circuit_to_gate.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.converters.circuit_to_gate --- -# qiskit.converters.circuit\_to\_gate[¶](#qiskit-converters-circuit-to-gate "Permalink to this headline") +# qiskit.converters.circuit\_to\_gate -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_gate.py "view source code") Build a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.41/qiskit.converters.circuit_to_instruction.md b/docs/api/qiskit/0.41/qiskit.converters.circuit_to_instruction.md index 1649b973780..f5a284ba829 100644 --- a/docs/api/qiskit/0.41/qiskit.converters.circuit_to_instruction.md +++ b/docs/api/qiskit/0.41/qiskit.converters.circuit_to_instruction.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.converters.circuit_to_instruction --- -# qiskit.converters.circuit\_to\_instruction[¶](#qiskit-converters-circuit-to-instruction "Permalink to this headline") +# qiskit.converters.circuit\_to\_instruction -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/circuit_to_instruction.py "view source code") Build an [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). diff --git a/docs/api/qiskit/0.41/qiskit.converters.dag_to_circuit.md b/docs/api/qiskit/0.41/qiskit.converters.dag_to_circuit.md index fb7a9aa623d..3031588a9d3 100644 --- a/docs/api/qiskit/0.41/qiskit.converters.dag_to_circuit.md +++ b/docs/api/qiskit/0.41/qiskit.converters.dag_to_circuit.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.converters.dag_to_circuit --- -# qiskit.converters.dag\_to\_circuit[¶](#qiskit-converters-dag-to-circuit "Permalink to this headline") +# qiskit.converters.dag\_to\_circuit -`dag_to_circuit(dag)` +`dag_to_circuit(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dag_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.41/qiskit.converters.dag_to_dagdependency.md b/docs/api/qiskit/0.41/qiskit.converters.dag_to_dagdependency.md index 671df9d7ce6..647d2503827 100644 --- a/docs/api/qiskit/0.41/qiskit.converters.dag_to_dagdependency.md +++ b/docs/api/qiskit/0.41/qiskit.converters.dag_to_dagdependency.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.converters.dag_to_dagdependency --- -# qiskit.converters.dag\_to\_dagdependency[¶](#qiskit-converters-dag-to-dagdependency "Permalink to this headline") +# qiskit.converters.dag\_to\_dagdependency -`dag_to_dagdependency(dag, create_preds_and_succs=True)` +`dag_to_dagdependency(dag, create_preds_and_succs=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dag_to_dagdependency.py "view source code") Build a `DAGDependency` object from a `DAGCircuit`. diff --git a/docs/api/qiskit/0.41/qiskit.converters.dagdependency_to_circuit.md b/docs/api/qiskit/0.41/qiskit.converters.dagdependency_to_circuit.md index fc75c73952e..cdb6a6fe1f2 100644 --- a/docs/api/qiskit/0.41/qiskit.converters.dagdependency_to_circuit.md +++ b/docs/api/qiskit/0.41/qiskit.converters.dagdependency_to_circuit.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.converters.dagdependency_to_circuit --- -# qiskit.converters.dagdependency\_to\_circuit[¶](#qiskit-converters-dagdependency-to-circuit "Permalink to this headline") +# qiskit.converters.dagdependency\_to\_circuit -`dagdependency_to_circuit(dagdependency)` +`dagdependency_to_circuit(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dagdependency_to_circuit.py "view source code") Build a `QuantumCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.41/qiskit.converters.dagdependency_to_dag.md b/docs/api/qiskit/0.41/qiskit.converters.dagdependency_to_dag.md index 34cf691f89f..d9b24a128f4 100644 --- a/docs/api/qiskit/0.41/qiskit.converters.dagdependency_to_dag.md +++ b/docs/api/qiskit/0.41/qiskit.converters.dagdependency_to_dag.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.converters.dagdependency_to_dag --- -# qiskit.converters.dagdependency\_to\_dag[¶](#qiskit-converters-dagdependency-to-dag "Permalink to this headline") +# qiskit.converters.dagdependency\_to\_dag -`dagdependency_to_dag(dagdependency)` +`dagdependency_to_dag(dagdependency)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/converters/dagdependency_to_dag.py "view source code") Build a `DAGCircuit` object from a `DAGDependency`. diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollapser.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollapser.md index 18ccb9c03cf..ff178b6d025 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollapser.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollapser.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.dagcircuit.BlockCollapser --- -# BlockCollapser[¶](#blockcollapser "Permalink to this headline") +# BlockCollapser -`BlockCollapser(dag)` +`BlockCollapser(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ This class implements various strategies of consolidating blocks of nodes in a D -`BlockCollapser.collapse_to_operation(blocks, collapse_fn)` +`BlockCollapser.collapse_to_operation(blocks, collapse_fn)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") For each block, constructs a quantum circuit containing instructions in the block, then uses collapse\_fn to collapse this circuit into a single operation. diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollector.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollector.md index 36dab057424..0ea27eb7ae8 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollector.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.BlockCollector.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.dagcircuit.BlockCollector --- -# BlockCollector[¶](#blockcollector "Permalink to this headline") +# BlockCollector -`BlockCollector(dag)` +`BlockCollector(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ In general, there are multiple ways to collect maximal blocks. The approaches us -`BlockCollector.collect_all_matching_blocks(filter_fn, split_blocks=True, min_block_size=2)` +`BlockCollector.collect_all_matching_blocks(filter_fn, split_blocks=True, min_block_size=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") Collects all blocks that match a given filtering function filter\_fn. @@ -50,7 +50,7 @@ Returns the list of matching blocks only. -`BlockCollector.collect_matching_block(filter_fn)` +`BlockCollector.collect_matching_block(filter_fn)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/collect_blocks.py "view source code") Iteratively collects the largest block of input nodes diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuit.md index 8c0433e828f..13bc803029a 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuit.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.dagcircuit.DAGCircuit --- -# DAGCircuit[¶](#dagcircuit "Permalink to this headline") +# DAGCircuit -`DAGCircuit` +`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: `object` @@ -26,7 +26,7 @@ Create an empty circuit. -`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)` +`DAGCircuit.add_calibration(gate, qubits, schedule, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Register a low-level, custom pulse definition for the given gate. @@ -45,7 +45,7 @@ Register a low-level, custom pulse definition for the given gate. -`DAGCircuit.add_clbits(clbits)` +`DAGCircuit.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual clbit wires. @@ -53,7 +53,7 @@ Add individual clbit wires. -`DAGCircuit.add_creg(creg)` +`DAGCircuit.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a classical register. @@ -61,7 +61,7 @@ Add all wires in a classical register. -`DAGCircuit.add_qreg(qreg)` +`DAGCircuit.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Add all wires in a quantum register. @@ -69,7 +69,7 @@ Add all wires in a quantum register. -`DAGCircuit.add_qubits(qubits)` +`DAGCircuit.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Add individual qubit wires. @@ -77,7 +77,7 @@ Add individual qubit wires. -`DAGCircuit.ancestors(node)` +`DAGCircuit.ancestors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. @@ -85,7 +85,7 @@ Returns set of the ancestors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.apply_operation_back(op, qargs=(), cargs=())` +`DAGCircuit.apply_operation_back(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the output of the circuit. @@ -111,7 +111,7 @@ the node for the op that was added to the dag -`DAGCircuit.apply_operation_front(op, qargs=(), cargs=())` +`DAGCircuit.apply_operation_front(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Apply an operation to the input of the circuit. @@ -137,7 +137,7 @@ the node for the op that was added to the dag -`DAGCircuit.bfs_successors(node)` +`DAGCircuit.bfs_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order. @@ -145,7 +145,7 @@ Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the -`DAGCircuit.collect_1q_runs()` +`DAGCircuit.collect_1q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 1q “op” nodes. @@ -153,7 +153,7 @@ Return a set of non-conditional runs of 1q “op” nodes. -`DAGCircuit.collect_2q_runs()` +`DAGCircuit.collect_2q_runs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of 2q “op” nodes. @@ -161,7 +161,7 @@ Return a set of non-conditional runs of 2q “op” nodes. -`DAGCircuit.collect_runs(namelist)` +`DAGCircuit.collect_runs(namelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a set of non-conditional runs of “op” nodes with the given names. @@ -173,7 +173,7 @@ Nodes must have only one successor to continue the run. -`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)` +`DAGCircuit.compose(other, qubits=None, clbits=None, front=False, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Compose the `other` circuit onto the output of this circuit. @@ -205,7 +205,7 @@ the composed dag (returns None if inplace==True). -`DAGCircuit.copy_empty_like()` +`DAGCircuit.copy_empty_like()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a copy of self with the same structure but empty. @@ -228,7 +228,7 @@ An empty copy of self. -`DAGCircuit.count_ops(*, recurse=True)` +`DAGCircuit.count_ops(*, recurse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names. @@ -248,7 +248,7 @@ Mapping\[str, int] -`DAGCircuit.count_ops_longest_path()` +`DAGCircuit.count_ops_longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Count the occurrences of operation names on the longest path. @@ -258,7 +258,7 @@ Returns a dictionary of counts keyed on the operation name. -`DAGCircuit.depth(*, recurse=False)` +`DAGCircuit.depth(*, recurse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the circuit depth. If there is control flow present, this count may only be an estimate, as the complete control-flow path cannot be staticly known. @@ -283,7 +283,7 @@ int -`DAGCircuit.descendants(node)` +`DAGCircuit.descendants(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. @@ -291,7 +291,7 @@ Returns set of the descendants of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.draw(scale=0.7, filename=None, style='color')` +`DAGCircuit.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Draws the dag circuit. @@ -315,7 +315,7 @@ Ipython.display.Image -`DAGCircuit.edges(nodes=None)` +`DAGCircuit.edges(nodes=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for edge values and source and dest node @@ -337,7 +337,7 @@ This works by returning the output edges from the specified nodes. If no nodes a -`DAGCircuit.front_layer()` +`DAGCircuit.front_layer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a list of op nodes in the first layer of this dag. @@ -345,7 +345,7 @@ Return a list of op nodes in the first layer of this dag. -`DAGCircuit.gate_nodes()` +`DAGCircuit.gate_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of gate nodes in the dag. @@ -361,7 +361,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.has_calibration_for(node)` +`DAGCircuit.has_calibration_for(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return True if the dag has a calibration defined for the node operation. In this case, the operation does not need to be translated to the device basis. @@ -369,7 +369,7 @@ Return True if the dag has a calibration defined for the node operation. In this -`DAGCircuit.idle_wires(ignore=None)` +`DAGCircuit.idle_wires(ignore=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return idle wires. @@ -389,7 +389,7 @@ Return idle wires. -`DAGCircuit.is_predecessor(node, node_pred)` +`DAGCircuit.is_predecessor(node, node_pred)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the predecessors of node. @@ -397,7 +397,7 @@ Checks if a second node is in the predecessors of node. -`DAGCircuit.is_successor(node, node_succ)` +`DAGCircuit.is_successor(node, node_succ)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Checks if a second node is in the successors of node. @@ -405,7 +405,7 @@ Checks if a second node is in the successors of node. -`DAGCircuit.layers()` +`DAGCircuit.layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit. @@ -419,7 +419,7 @@ TODO: Gates that use the same cbits will end up in different layers as this is c -`DAGCircuit.longest_path()` +`DAGCircuit.longest_path()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAGOutNodes. @@ -427,7 +427,7 @@ Returns the longest path in the dag as a list of DAGOpNodes, DAGInNodes, and DAG -`DAGCircuit.multi_qubit_ops()` +`DAGCircuit.multi_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. @@ -435,7 +435,7 @@ Get list of 3+ qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.multigraph_layers()` +`DAGCircuit.multigraph_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield layers of the multigraph. @@ -443,7 +443,7 @@ Yield layers of the multigraph. -`DAGCircuit.named_nodes(*names)` +`DAGCircuit.named_nodes(*names)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get the set of “op” nodes with the given name. @@ -451,7 +451,7 @@ Get the set of “op” nodes with the given name. -`DAGCircuit.node(node_id)` +`DAGCircuit.node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get the node in the dag. @@ -471,7 +471,7 @@ node -`DAGCircuit.nodes()` +`DAGCircuit.nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for node values. @@ -483,7 +483,7 @@ Iterator for node values. -`DAGCircuit.nodes_on_wire(wire, only_ops=False)` +`DAGCircuit.nodes_on_wire(wire, only_ops=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Iterator for nodes that affect a given wire. @@ -504,7 +504,7 @@ Iterator for nodes that affect a given wire. -`DAGCircuit.num_clbits()` +`DAGCircuit.num_clbits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of classical bits used by the circuit. @@ -512,7 +512,7 @@ Return the total number of classical bits used by the circuit. -`DAGCircuit.num_qubits()` +`DAGCircuit.num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits used by the circuit. num\_qubits() replaces former use of width(). DAGCircuit.width() now returns qubits + clbits for consistency with Circuit.width() \[qiskit-terra #2564]. @@ -520,7 +520,7 @@ Return the total number of qubits used by the circuit. num\_qubits() replaces fo -`DAGCircuit.num_tensor_factors()` +`DAGCircuit.num_tensor_factors()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Compute how many components the circuit can decompose into. @@ -528,7 +528,7 @@ Compute how many components the circuit can decompose into. -`DAGCircuit.op_nodes(op=None, include_directives=True)` +`DAGCircuit.op_nodes(op=None, include_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get the list of “op” nodes in the dag. @@ -549,7 +549,7 @@ list\[[DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode")] -`DAGCircuit.predecessors(node)` +`DAGCircuit.predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. @@ -557,7 +557,7 @@ Returns iterator of the predecessors of a node as DAGOpNodes and DAGInNodes. -`DAGCircuit.properties()` +`DAGCircuit.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return a dictionary of circuit properties. @@ -565,7 +565,7 @@ Return a dictionary of circuit properties. -`DAGCircuit.quantum_predecessors(node)` +`DAGCircuit.quantum_predecessors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGOpNodes and DAGInNodes. @@ -573,7 +573,7 @@ Returns iterator of the predecessors of a node that are connected by a quantum e -`DAGCircuit.quantum_successors(node)` +`DAGCircuit.quantum_successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node that are connected by a quantum edge as Opnodes and DAGOutNodes. @@ -581,7 +581,7 @@ Returns iterator of the successors of a node that are connected by a quantum edg -`DAGCircuit.remove_all_ops_named(opname)` +`DAGCircuit.remove_all_ops_named(opname)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all operation nodes with the given name. @@ -589,7 +589,7 @@ Remove all operation nodes with the given name. -`DAGCircuit.remove_ancestors_of(node)` +`DAGCircuit.remove_ancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the ancestor operation nodes of node. @@ -597,7 +597,7 @@ Remove all of the ancestor operation nodes of node. -`DAGCircuit.remove_clbits(*clbits)` +`DAGCircuit.remove_clbits(*clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical bits from the circuit. All bits MUST be idle. Any registers with references to at least one of the specified bits will also be removed. @@ -613,7 +613,7 @@ Remove classical bits from the circuit. All bits MUST be idle. Any registers wit -`DAGCircuit.remove_cregs(*cregs)` +`DAGCircuit.remove_cregs(*cregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical registers from the circuit, leaving underlying bits in place. @@ -626,7 +626,7 @@ Remove classical registers from the circuit, leaving underlying bits in place. -`DAGCircuit.remove_descendants_of(node)` +`DAGCircuit.remove_descendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the descendant operation nodes of node. @@ -634,7 +634,7 @@ Remove all of the descendant operation nodes of node. -`DAGCircuit.remove_nonancestors_of(node)` +`DAGCircuit.remove_nonancestors_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-ancestors operation nodes of node. @@ -642,7 +642,7 @@ Remove all of the non-ancestors operation nodes of node. -`DAGCircuit.remove_nondescendants_of(node)` +`DAGCircuit.remove_nondescendants_of(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove all of the non-descendants operation nodes of node. @@ -650,7 +650,7 @@ Remove all of the non-descendants operation nodes of node. -`DAGCircuit.remove_op_node(node)` +`DAGCircuit.remove_op_node(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove an operation node n. @@ -660,7 +660,7 @@ Add edges from predecessors to successors. -`DAGCircuit.remove_qregs(*qregs)` +`DAGCircuit.remove_qregs(*qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove classical registers from the circuit, leaving underlying bits in place. @@ -673,7 +673,7 @@ Remove classical registers from the circuit, leaving underlying bits in place. -`DAGCircuit.remove_qubits(*qubits)` +`DAGCircuit.remove_qubits(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Remove quantum bits from the circuit. All bits MUST be idle. Any registers with references to at least one of the specified bits will also be removed. @@ -689,7 +689,7 @@ Remove quantum bits from the circuit. All bits MUST be idle. Any registers with -`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)` +`DAGCircuit.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Replace a block of nodes with a single node. @@ -718,7 +718,7 @@ The op node that replaces the block. -`DAGCircuit.reverse_ops()` +`DAGCircuit.reverse_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Reverse the operations in the `self` circuit. @@ -734,7 +734,7 @@ the reversed dag. -`DAGCircuit.serial_layers()` +`DAGCircuit.serial_layers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield a layer for all gates of this circuit. @@ -744,7 +744,7 @@ A serial layer is a circuit with one gate. The layers have the same structure as -`DAGCircuit.size(*, recurse=False)` +`DAGCircuit.size(*, recurse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the number of operations. If there is control flow present, this count may only be an estimate, as the complete control-flow path cannot be statically known. @@ -768,7 +768,7 @@ int -`DAGCircuit.substitute_node(node, op, inplace=False)` +`DAGCircuit.substitute_node(node, op, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Replace an DAGOpNode with a single operation. qargs, cargs and conditions for the new operation will be inferred from the node to be replaced. The new operation will be checked to match the shape of the replaced operation. @@ -795,7 +795,7 @@ the new node containing the added operation. -`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None, propagate_condition=True)` +`DAGCircuit.substitute_node_with_dag(node, input_dag, wires=None, propagate_condition=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Replace one node with dag. @@ -822,7 +822,7 @@ dict -`DAGCircuit.successors(node)` +`DAGCircuit.successors(node)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. @@ -830,7 +830,7 @@ Returns iterator of the successors of a node as DAGOpNodes and DAGOutNodes. -`DAGCircuit.topological_nodes(key=None)` +`DAGCircuit.topological_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield nodes in topological order. @@ -850,7 +850,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.topological_op_nodes(key=None)` +`DAGCircuit.topological_op_nodes(key=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Yield op nodes in topological order. @@ -872,7 +872,7 @@ generator([DAGOpNode](qiskit.dagcircuit.DAGOpNode "qiskit.dagcircuit.DAGOpNode") -`DAGCircuit.two_qubit_ops()` +`DAGCircuit.two_qubit_ops()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Get list of 2 qubit operations. Ignore directives like snapshot and barrier. @@ -880,7 +880,7 @@ Get list of 2 qubit operations. Ignore directives like snapshot and barrier. -`DAGCircuit.width()` +`DAGCircuit.width()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagcircuit.py "view source code") Return the total number of qubits + clbits used by the circuit. This function formerly returned the number of qubits by the calculation return len(self.\_wires) - self.num\_clbits() but was changed by issue #2564 to return number of qubits + clbits with the new function DAGCircuit.num\_qubits replacing the former semantic of DAGCircuit.width(). diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuitError.md index 4ec18ef79fc..388202e6b04 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGCircuitError.md @@ -6,11 +6,11 @@ python_api_type: exception python_api_name: qiskit.dagcircuit.DAGCircuitError --- -# qiskit.dagcircuit.DAGCircuitError[¶](#qiskit-dagcircuit-dagcircuiterror "Permalink to this headline") +# qiskit.dagcircuit.DAGCircuitError -`DAGCircuitError(*msg)` +`DAGCircuitError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/exceptions.py "view source code") Base class for errors raised by the DAGCircuit object. diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDepNode.md index 62246850b78..5f9cb4a3aa5 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDepNode.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.dagcircuit.DAGDepNode --- -# DAGDepNode[¶](#dagdepnode "Permalink to this headline") +# DAGDepNode -`DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)` +`DAGDepNode(type=None, op=None, name=None, qargs=(), cargs=(), condition=None, successors=None, predecessors=None, reachable=None, matchedwith=None, successorstovisit=None, isblocked=None, qindices=None, cindices=None, nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It is used as the return value from \*\_nodes() functions and can be supplied to -`DAGDepNode.copy()` +`DAGDepNode.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. :rtype: DAGDepNode @@ -32,7 +32,7 @@ Function to copy a DAGDepNode object. :returns: a copy of a DAGDepNode object. : -`static DAGDepNode.semantic_eq(node1, node2)` +`static DAGDepNode.semantic_eq(node1, node2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdepnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDependency.md index a6057362827..c01ae8d158d 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGDependency.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.dagcircuit.DAGDependency --- -# DAGDependency[¶](#dagdependency "Permalink to this headline") +# DAGDependency -`DAGDependency` +`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Bases: `object` @@ -46,7 +46,7 @@ Create an empty DAGDependency. -`DAGDependency.add_clbits(clbits)` +`DAGDependency.add_clbits(clbits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add individual clbit wires. @@ -54,7 +54,7 @@ Add individual clbit wires. -`DAGDependency.add_creg(creg)` +`DAGDependency.add_creg(creg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add clbits in a classical register. @@ -62,7 +62,7 @@ Add clbits in a classical register. -`DAGDependency.add_op_node(operation, qargs, cargs)` +`DAGDependency.add_op_node(operation, qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add a DAGDepNode to the graph and update the edges. @@ -76,7 +76,7 @@ Add a DAGDepNode to the graph and update the edges. -`DAGDependency.add_qreg(qreg)` +`DAGDependency.add_qreg(qreg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add qubits in a quantum register. @@ -84,7 +84,7 @@ Add qubits in a quantum register. -`DAGDependency.add_qubits(qubits)` +`DAGDependency.add_qubits(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Add individual qubit wires. @@ -92,7 +92,7 @@ Add individual qubit wires. -`DAGDependency.copy()` +`DAGDependency.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Function to copy a DAGDependency object. :returns: a copy of a DAGDependency object. :rtype: DAGDependency @@ -100,7 +100,7 @@ Function to copy a DAGDependency object. :returns: a copy of a DAGDependency obj -`DAGDependency.depth()` +`DAGDependency.depth()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Return the circuit depth. :returns: the circuit depth :rtype: int @@ -108,7 +108,7 @@ Return the circuit depth. :returns: the circuit depth :rtype: int -`DAGDependency.direct_predecessors(node_id)` +`DAGDependency.direct_predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Direct predecessors id of a given node as sorted list. @@ -128,7 +128,7 @@ List -`DAGDependency.direct_successors(node_id)` +`DAGDependency.direct_successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Direct successors id of a given node as sorted list. @@ -148,7 +148,7 @@ List -`DAGDependency.draw(scale=0.7, filename=None, style='color')` +`DAGDependency.draw(scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Draws the DAGDependency graph. @@ -174,7 +174,7 @@ Ipython.display.Image -`DAGDependency.get_all_edges()` +`DAGDependency.get_all_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all edges. @@ -190,7 +190,7 @@ List -`DAGDependency.get_edges(src_id, dest_id)` +`DAGDependency.get_edges(src_id, dest_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Edge enumeration between two nodes through method get\_all\_edge\_data. @@ -211,7 +211,7 @@ List -`DAGDependency.get_in_edges(node_id)` +`DAGDependency.get_in_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all incoming edges for a given node. @@ -231,7 +231,7 @@ List -`DAGDependency.get_node(node_id)` +`DAGDependency.get_node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") **Parameters** @@ -249,7 +249,7 @@ node -`DAGDependency.get_nodes()` +`DAGDependency.get_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") **Returns** @@ -263,7 +263,7 @@ generator(dict) -`DAGDependency.get_out_edges(node_id)` +`DAGDependency.get_out_edges(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Enumeration of all outgoing edges for a given node. @@ -283,7 +283,7 @@ List -`DAGDependency.predecessors(node_id)` +`DAGDependency.predecessors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Predecessors id of a given node as sorted list. @@ -303,7 +303,7 @@ List -`DAGDependency.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)` +`DAGDependency.replace_block_with_op(node_block, op, wire_pos_map, cycle_check=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Replace a block of nodes with a single node. @@ -326,7 +326,7 @@ It is important that such consolidation preserves commutativity assumptions pres -`DAGDependency.size()` +`DAGDependency.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Returns the number of gates in the circuit @@ -334,7 +334,7 @@ Returns the number of gates in the circuit -`DAGDependency.successors(node_id)` +`DAGDependency.successors(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Successors id of a given node as sorted list. @@ -354,7 +354,7 @@ List -`DAGDependency.to_retworkx()` +`DAGDependency.to_retworkx()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Returns the DAGDependency in retworkx format. @@ -362,7 +362,7 @@ Returns the DAGDependency in retworkx format. -`DAGDependency.topological_nodes()` +`DAGDependency.topological_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagdependency.py "view source code") Yield nodes in topological order. diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGInNode.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGInNode.md index ed431164ae8..aa28a3cb373 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGInNode.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGInNode.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.dagcircuit.DAGInNode --- -# DAGInNode[¶](#daginnode "Permalink to this headline") +# DAGInNode -`DAGInNode(wire)` +`DAGInNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGNode.md index 88c1486cf74..7bef1e4c88c 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGNode.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.dagcircuit.DAGNode --- -# DAGNode[¶](#dagnode "Permalink to this headline") +# DAGNode -`DAGNode(nid=- 1)` +`DAGNode(nid=- 1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create a node -`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)` +`static DAGNode.semantic_eq(node1, node2, bit_indices1=None, bit_indices2=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOpNode.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOpNode.md index 0927d930d24..7f9f85795fb 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOpNode.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOpNode.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.dagcircuit.DAGOpNode --- -# DAGOpNode[¶](#dagopnode "Permalink to this headline") +# DAGOpNode -`DAGOpNode(op, qargs=(), cargs=())` +`DAGOpNode(op, qargs=(), cargs=())`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOutNode.md b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOutNode.md index 3dbe091d316..30edf3e38a5 100644 --- a/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOutNode.md +++ b/docs/api/qiskit/0.41/qiskit.dagcircuit.DAGOutNode.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.dagcircuit.DAGOutNode --- -# DAGOutNode[¶](#dagoutnode "Permalink to this headline") +# DAGOutNode -`DAGOutNode(wire)` +`DAGOutNode(wire)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/dagcircuit/dagnode.py "view source code") Bases: [`qiskit.dagcircuit.dagnode.DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.dagnode.DAGNode") diff --git a/docs/api/qiskit/0.41/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.41/qiskit.extensions.HamiltonianGate.md index 4dbcf90e3ee..32de719c924 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.41/qiskit.extensions.HamiltonianGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.extensions.HamiltonianGate --- -# HamiltonianGate[¶](#hamiltoniangate "Permalink to this headline") +# HamiltonianGate -`HamiltonianGate(data, time, label=None)` +`HamiltonianGate(data, time, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -42,7 +42,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`HamiltonianGate.adjoint()` +`HamiltonianGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -125,7 +125,7 @@ Set a classical equality condition on this instruction between the register or c -`HamiltonianGate.conjugate()` +`HamiltonianGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Return the conjugate of the Hamiltonian. @@ -181,7 +181,7 @@ updated if it was provided -`HamiltonianGate.inverse()` +`HamiltonianGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Return the adjoint of the unitary. @@ -221,7 +221,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`HamiltonianGate.qasm()` +`HamiltonianGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Raise an error, as QASM is not defined for the HamiltonianGate. @@ -313,7 +313,7 @@ np.ndarray -`HamiltonianGate.transpose()` +`HamiltonianGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Return the transpose of the Hamiltonian. @@ -321,7 +321,7 @@ Return the transpose of the Hamiltonian. -`HamiltonianGate.validate_parameter(parameter)` +`HamiltonianGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/hamiltonian_gate.py "view source code") Hamiltonian parameter has to be an ndarray, operator or float. diff --git a/docs/api/qiskit/0.41/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.41/qiskit.extensions.Initialize.md index 032c1e4419f..bd56ab00cc5 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.41/qiskit.extensions.Initialize.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.extensions.Initialize --- -# Initialize[¶](#initialize "Permalink to this headline") +# Initialize -`Initialize(params, num_qubits=None)` +`Initialize(params, num_qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -53,7 +53,7 @@ Assemble a QasmQobjInstruction -`Initialize.broadcast_arguments(qargs, cargs)` +`Initialize.broadcast_arguments(qargs, cargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") Validation of the arguments. @@ -108,7 +108,7 @@ updated if it was provided -`Initialize.gates_to_uncompute()` +`Initialize.gates_to_uncompute()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/initializer.py "view source code") Call to create a circuit with gates that take the desired vector to zero. diff --git a/docs/api/qiskit/0.41/qiskit.extensions.SingleQubitUnitary.md b/docs/api/qiskit/0.41/qiskit.extensions.SingleQubitUnitary.md index 9266bc7ae9d..d280020ae1f 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.SingleQubitUnitary.md +++ b/docs/api/qiskit/0.41/qiskit.extensions.SingleQubitUnitary.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.extensions.SingleQubitUnitary --- -# SingleQubitUnitary[¶](#singlequbitunitary "Permalink to this headline") +# SingleQubitUnitary -`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)` +`SingleQubitUnitary(unitary_matrix, mode='ZYZ', up_to_diagonal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -161,7 +161,7 @@ updated if it was provided -`SingleQubitUnitary.inverse()` +`SingleQubitUnitary.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") Return the inverse. @@ -297,7 +297,7 @@ np.ndarray -`SingleQubitUnitary.validate_parameter(parameter)` +`SingleQubitUnitary.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/squ.py "view source code") Single-qubit unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.41/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.41/qiskit.extensions.Snapshot.md index 152e801576a..92c4998e5b8 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.41/qiskit.extensions.Snapshot.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.extensions.Snapshot --- -# Snapshot[¶](#snapshot "Permalink to this headline") +# Snapshot -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") @@ -44,7 +44,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`Snapshot.assemble()` +`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") Assemble a QasmQobjInstruction @@ -73,7 +73,7 @@ Validation of the arguments. -`Snapshot.c_if(classical, val)` +`Snapshot.c_if(classical, val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`. @@ -107,7 +107,7 @@ updated if it was provided -`Snapshot.inverse()` +`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/simulator/snapshot.py "view source code") Special case. Return self. diff --git a/docs/api/qiskit/0.41/qiskit.extensions.UCPauliRotGate.md b/docs/api/qiskit/0.41/qiskit.extensions.UCPauliRotGate.md index 6c59bfccc28..12a96968c46 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.UCPauliRotGate.md +++ b/docs/api/qiskit/0.41/qiskit.extensions.UCPauliRotGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.extensions.UCPauliRotGate --- -# UCPauliRotGate[¶](#ucpaulirotgate "Permalink to this headline") +# UCPauliRotGate -`UCPauliRotGate(angle_list, rot_axis)` +`UCPauliRotGate(angle_list, rot_axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/uc_pauli_rot.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") diff --git a/docs/api/qiskit/0.41/qiskit.extensions.UCRXGate.md b/docs/api/qiskit/0.41/qiskit.extensions.UCRXGate.md index 94240451a75..3fe670fee26 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.UCRXGate.md +++ b/docs/api/qiskit/0.41/qiskit.extensions.UCRXGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.extensions.UCRXGate --- -# UCRXGate[¶](#ucrxgate "Permalink to this headline") +# UCRXGate -`UCRXGate(angle_list)` +`UCRXGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucrx.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.41/qiskit.extensions.UCRYGate.md b/docs/api/qiskit/0.41/qiskit.extensions.UCRYGate.md index ebd8c7fcde3..d9e0b5ecd18 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.UCRYGate.md +++ b/docs/api/qiskit/0.41/qiskit.extensions.UCRYGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.extensions.UCRYGate --- -# UCRYGate[¶](#ucrygate "Permalink to this headline") +# UCRYGate -`UCRYGate(angle_list)` +`UCRYGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucry.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.41/qiskit.extensions.UCRZGate.md b/docs/api/qiskit/0.41/qiskit.extensions.UCRZGate.md index b45975deedb..d6e014491de 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.UCRZGate.md +++ b/docs/api/qiskit/0.41/qiskit.extensions.UCRZGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.extensions.UCRZGate --- -# UCRZGate[¶](#ucrzgate "Permalink to this headline") +# UCRZGate -`UCRZGate(angle_list)` +`UCRZGate(angle_list)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/quantum_initializer/ucrz.py "view source code") Bases: [`qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate`](qiskit.extensions.UCPauliRotGate "qiskit.extensions.quantum_initializer.uc_pauli_rot.UCPauliRotGate") diff --git a/docs/api/qiskit/0.41/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.41/qiskit.extensions.UnitaryGate.md index d75d7e0aadd..b97432ed6af 100644 --- a/docs/api/qiskit/0.41/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.41/qiskit.extensions.UnitaryGate.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.extensions.UnitaryGate --- -# UnitaryGate[¶](#unitarygate "Permalink to this headline") +# UnitaryGate -`UnitaryGate(data, label=None)` +`UnitaryGate(data, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Bases: [`qiskit.circuit.gate.Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") @@ -59,7 +59,7 @@ Add a decomposition of the instruction to the SessionEquivalenceLibrary. -`UnitaryGate.adjoint()` +`UnitaryGate.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -142,7 +142,7 @@ Set a classical equality condition on this instruction between the register or c -`UnitaryGate.conjugate()` +`UnitaryGate.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return the conjugate of the unitary. @@ -150,7 +150,7 @@ Return the conjugate of the unitary. -`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` +`UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return controlled version of gate @@ -199,7 +199,7 @@ updated if it was provided -`UnitaryGate.inverse()` +`UnitaryGate.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return the adjoint of the unitary. @@ -239,7 +239,7 @@ To which to\_matrix is self.to\_matrix^exponent. -`UnitaryGate.qasm()` +`UnitaryGate.qasm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate. It gives the gate a random name if one hasn’t been given to it. @@ -331,7 +331,7 @@ np.ndarray -`UnitaryGate.transpose()` +`UnitaryGate.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Return the transpose of the unitary. @@ -339,7 +339,7 @@ Return the transpose of the unitary. -`UnitaryGate.validate_parameter(parameter)` +`UnitaryGate.validate_parameter(parameter)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/extensions/unitary.py "view source code") Unitary gate parameter has to be an ndarray. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.OperatorBase.md b/docs/api/qiskit/0.41/qiskit.opflow.OperatorBase.md index c5688bcb250..a7ae52d9bbe 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.OperatorBase.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.OperatorBase --- -# OperatorBase[¶](#operatorbase "Permalink to this headline") +# OperatorBase -`OperatorBase` +`OperatorBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Bases: `qiskit.opflow.mixins.star_algebra.StarAlgebraMixin`, `qiskit.opflow.mixins.tensor.TensorMixin`, `abc.ABC` @@ -24,7 +24,7 @@ Operators can be used to construct complicated functions and computation, and se -`abstract OperatorBase.add(other)` +`abstract OperatorBase.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`abstract OperatorBase.adjoint()` +`abstract OperatorBase.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -60,7 +60,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`abstract OperatorBase.assign_parameters(param_dict)` +`abstract OperatorBase.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -80,7 +80,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`OperatorBase.bind_parameters(param_dict)` +`OperatorBase.bind_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). @@ -92,7 +92,7 @@ Same as assign\_parameters, but maintained for consistency with QuantumCircuit i -`abstract OperatorBase.compose(other, permutation=None, front=False)` +`abstract OperatorBase.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -120,7 +120,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`OperatorBase.copy()` +`OperatorBase.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return a deep copy of the Operator. @@ -132,7 +132,7 @@ Return a deep copy of the Operator. -`abstract OperatorBase.equals(other)` +`abstract OperatorBase.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -152,7 +152,7 @@ A bool equal to the equality of self and other. -`abstract OperatorBase.eval(front=None)` +`abstract OperatorBase.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -174,7 +174,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorBase.is_hermitian()` +`OperatorBase.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return True if the operator is hermitian. @@ -188,7 +188,7 @@ Returns: Boolean value -`abstract OperatorBase.mul(scalar)` +`abstract OperatorBase.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -208,7 +208,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`OperatorBase.neg()` +`OperatorBase.neg()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. @@ -224,7 +224,7 @@ An `OperatorBase` equivalent to the negation of self. -`abstract OperatorBase.permute(permutation)` +`abstract OperatorBase.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Permutes the qubits of the operator. @@ -248,7 +248,7 @@ A new OperatorBase containing the permuted operator. -`abstract OperatorBase.primitive_strings()` +`abstract OperatorBase.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -264,7 +264,7 @@ A set of strings describing the primitives contained within the Operator. -`abstract OperatorBase.reduce()` +`abstract OperatorBase.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -276,7 +276,7 @@ The reduced `OperatorBase`. -`abstract OperatorBase.tensor(other)` +`abstract OperatorBase.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -300,7 +300,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`abstract OperatorBase.tensorpower(other)` +`abstract OperatorBase.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -320,7 +320,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`abstract OperatorBase.to_circuit_op()` +`abstract OperatorBase.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -332,7 +332,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`abstract OperatorBase.to_matrix(massive=False)` +`abstract OperatorBase.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -348,7 +348,7 @@ The NumPy `ndarray` equivalent to this Operator. -`abstract OperatorBase.to_matrix_op(massive=False)` +`abstract OperatorBase.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -360,7 +360,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`OperatorBase.to_spmatrix()` +`OperatorBase.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/operator_base.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.41/qiskit.opflow.OpflowError.md index 7bcb4f41767..47086c22c0a 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.OpflowError.md @@ -6,11 +6,11 @@ python_api_type: exception python_api_name: qiskit.opflow.OpflowError --- -# qiskit.opflow\.OpflowError[¶](#qiskit-opflow-opflowerror "Permalink to this headline") +# qiskit.opflow\.OpflowError -`OpflowError(*message)` +`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.anti_commutator.md b/docs/api/qiskit/0.41/qiskit.opflow.anti_commutator.md index b9295932084..e86d190e5a6 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.anti_commutator.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.opflow.anti_commutator --- -# qiskit.opflow\.anti\_commutator[¶](#qiskit-opflow-anti-commutator "Permalink to this headline") +# qiskit.opflow\.anti\_commutator -`anti_commutator(op_a, op_b)` +`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.commutator.md b/docs/api/qiskit/0.41/qiskit.opflow.commutator.md index d4e9dae9d94..6e5fb07c794 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.commutator.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.opflow.commutator --- -# qiskit.opflow\.commutator[¶](#qiskit-opflow-commutator "Permalink to this headline") +# qiskit.opflow\.commutator -`commutator(op_a, op_b)` +`commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") Compute commutator of op\_a and op\_b. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.AbelianGrouper.md b/docs/api/qiskit/0.41/qiskit.opflow.converters.AbelianGrouper.md index 43f3a22f5ec..0456cb9f228 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.AbelianGrouper.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.converters.AbelianGrouper --- -# AbelianGrouper[¶](#abeliangrouper "Permalink to this headline") +# AbelianGrouper -`AbelianGrouper(traverse=True)` +`AbelianGrouper(traverse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev -`AbelianGrouper.convert(operator)` +`AbelianGrouper.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") Check if operator is a SummedOp, in which case covert it into a sum of mutually commuting sums, or if the Operator contains sub-Operators and `traverse` is True, attempt to convert any sub-Operators. @@ -48,7 +48,7 @@ The converted Operator. -`classmethod AbelianGrouper.group_subops(list_op)` +`classmethod AbelianGrouper.group_subops(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/abelian_grouper.py "view source code") Given a ListOp, attempt to group into Abelian ListOps of the same type. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.CircuitSampler.md b/docs/api/qiskit/0.41/qiskit.opflow.converters.CircuitSampler.md index 21d4d0ab37a..e523e883979 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.CircuitSampler.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.converters.CircuitSampler --- -# CircuitSampler[¶](#circuitsampler "Permalink to this headline") +# CircuitSampler -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -36,7 +36,7 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete -`CircuitSampler.clear_cache()` +`CircuitSampler.clear_cache()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") Clear the cache of sampled operator expressions. @@ -48,7 +48,7 @@ Clear the cache of sampled operator expressions. -`CircuitSampler.convert(operator, params=None)` +`CircuitSampler.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. Extracts the CircuitStateFns out of the Operator, caches them, calls `sample_circuits` below to get their converted replacements, and replaces the CircuitStateFns in operator with the replacement StateFns. @@ -73,7 +73,7 @@ The converted Operator with CircuitStateFns replaced by DictStateFns or VectorSt -`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)` +`CircuitSampler.sample_circuits(circuit_sfns=None, param_bindings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/circuit_sampler.py "view source code") Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. If param\_bindings is provided, the CircuitStateFns are broken into their parameterizations, and a list of StateFns is returned in the dict for each circuit `id()`. Note that param\_bindings is provided here in a different format than in `convert`, and lists of parameters within the dict is not supported, and only binding dicts which are valid to be passed into Terra can be included in this list. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.ConverterBase.md b/docs/api/qiskit/0.41/qiskit.opflow.converters.ConverterBase.md index 626a5dca748..89d850ea221 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.ConverterBase.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.converters.ConverterBase --- -# ConverterBase[¶](#converterbase "Permalink to this headline") +# ConverterBase -`ConverterBase` +`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Converters take an Operator and return a new Operator, generally isomorphic in s -`abstract ConverterBase.convert(operator)` +`abstract ConverterBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/converter_base.py "view source code") Accept the Operator and return the converted Operator diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.DictToCircuitSum.md b/docs/api/qiskit/0.41/qiskit.opflow.converters.DictToCircuitSum.md index 929ada2a3d9..b1fd067d35a 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.DictToCircuitSum.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.converters.DictToCircuitSum --- -# DictToCircuitSum[¶](#dicttocircuitsum "Permalink to this headline") +# DictToCircuitSum -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s -`DictToCircuitSum.convert(operator)` +`DictToCircuitSum.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.PauliBasisChange.md b/docs/api/qiskit/0.41/qiskit.opflow.converters.PauliBasisChange.md index 1299132c5f3..f8678989b8f 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.PauliBasisChange.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.converters.PauliBasisChange --- -# PauliBasisChange[¶](#paulibasischange "Permalink to this headline") +# PauliBasisChange -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -39,7 +39,7 @@ This class uses the typical basis change method found in most Quantum Computing -`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)` +`PauliBasisChange.construct_cnot_chain(diag_pauli_op1, diag_pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` (or `PauliOp` if equal to the identity) which takes the eigenvectors of `diag_pauli_op1` to the eigenvectors of `diag_pauli_op2`, assuming both are diagonal (or performing this operation on their diagonalized Paulis implicitly if not). This works by the insight that the eigenvalue of a diagonal Pauli’s eigenvector is equal to or -1 if the parity is 1 and 1 if the parity is 0, or 1 - (2 \* parity). Therefore, using CNOTs, we can write the parity of diag\_pauli\_op1’s significant bits onto some qubit, and then write out that parity onto diag\_pauli\_op2’s significant bits. @@ -60,7 +60,7 @@ The `PrimitiveOp` performs the mapping. -`PauliBasisChange.convert(operator)` +`PauliBasisChange.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Given a `PauliOp`, or an Operator containing `PauliOps` if `_traverse` is True, converts each Pauli into the basis specified by self.\_destination and a basis-change-circuit, calls `replacement_fn` with these two Operators, and replaces the `PauliOps` with the output of `replacement_fn`. For example, for the built-in `operator_replacement_fn` below, each PauliOp p will be replaced by the composition of the basis-change Clifford `CircuitOp` c with the destination PauliOp d and c†, such that p = c·d·c†, up to global phase. @@ -80,7 +80,7 @@ The converted Operator. -`PauliBasisChange.get_cob_circuit(origin)` +`PauliBasisChange.get_cob_circuit(origin)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. It does so by @@ -112,7 +112,7 @@ A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` -`PauliBasisChange.get_diagonal_pauli_op(pauli_op)` +`PauliBasisChange.get_diagonal_pauli_op(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. @@ -132,7 +132,7 @@ The diagonal `PauliOp`. -`PauliBasisChange.get_diagonalizing_clifford(pauli)` +`PauliBasisChange.get_diagonalizing_clifford(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of |0⟩ and |1⟩ tensor products. Equivalently, finds the basis-change circuit to take `pauli` to a diagonal `PauliOp` composed only of Z and I tensor products. @@ -154,7 +154,7 @@ The diagonalizing `CircuitOp`. -`PauliBasisChange.get_tpb_pauli(list_op)` +`PauliBasisChange.get_tpb_pauli(list_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") Gets the Pauli (not `PauliOp`!) whose diagonalizing single-qubit rotations is a superset of the diagonalizing single-qubit rotations for each of the Paulis in `list_op`. TPB stands for Tensor Product Basis. @@ -174,7 +174,7 @@ The TBP Pauli. -`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)` +`static PauliBasisChange.measurement_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. @@ -195,7 +195,7 @@ The `~StateFn @ CircuitOp` composition equivalent to a measurement by the origin -`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)` +`static PauliBasisChange.operator_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. @@ -216,7 +216,7 @@ The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `P -`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)` +`PauliBasisChange.pad_paulis_to_equal_length(pauli_op1, pauli_op2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") If `pauli_op1` and `pauli_op2` do not act over the same number of qubits, pad identities to the end of the shorter of the two so they are of equal length. Padding is applied to the end of the Paulis. Note that the Terra represents Paulis in big-endian order, so this will appear as padding to the beginning of the Pauli x and z bit arrays. @@ -237,7 +237,7 @@ A tuple containing the padded PauliOps. -`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)` +`static PauliBasisChange.statefn_replacement_fn(cob_instr_op, dest_pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/pauli_basis_change.py "view source code") A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.TwoQubitReduction.md b/docs/api/qiskit/0.41/qiskit.opflow.converters.TwoQubitReduction.md index c48d83cb250..48a26ed1dfc 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.TwoQubitReduction.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.converters.TwoQubitReduction --- -# TwoQubitReduction[¶](#twoqubitreduction "Permalink to this headline") +# TwoQubitReduction -`TwoQubitReduction(num_particles)` +`TwoQubitReduction(num_particles)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ Chemistry specific method: It can be used to taper two qubits in parity and bina -`TwoQubitReduction.convert(operator)` +`TwoQubitReduction.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/converters/two_qubit_reduction.py "view source code") Converts the Operator to tapered one by Z2 symmetries. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.converters.md b/docs/api/qiskit/0.41/qiskit.opflow.converters.md index 17c71c75506..78c8d772f6c 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.converters.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.converters.md @@ -1,8 +1,8 @@ -# qiskit.opflow\.converters[¶](#module-qiskit.opflow.converters "Permalink to this headline") +# qiskit.opflow\.converters -## Converters ([`qiskit.opflow.converters`](#module-qiskit.opflow.converters "qiskit.opflow.converters"))[¶](#converters-qiskit-opflow-converters "Permalink to this headline") +## Converters ([`qiskit.opflow.converters`](#module-qiskit.opflow.converters "qiskit.opflow.converters")) Converters are objects which manipulate Operators, usually traversing an Operator to change certain sub-Operators into a desired representation. Often the converted Operator is isomorphic or approximate to the original Operator in some way, but not always. For example, a converter may accept [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") and return a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") of [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation") or [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution"), which convert [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s to [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")’s internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). @@ -10,7 +10,7 @@ Converters are objects which manipulate Operators, usually traversing an Operato Not all converters are in this module, as [`expectations`](qiskit.opflow.expectations#module-qiskit.opflow.expectations "qiskit.opflow.expectations") and [`evolutions`](qiskit.opflow.evolutions#module-qiskit.opflow.evolutions "qiskit.opflow.evolutions") are also converters. -### Converter Base Class[¶](#converter-base-class "Permalink to this headline") +### Converter Base Class The converter base class simply enforces the presence of a [`convert()`](qiskit.opflow.converters.ConverterBase#convert "qiskit.opflow.converters.ConverterBase.convert") method. @@ -18,7 +18,7 @@ The converter base class simply enforces the presence of a [`convert()`](qiskit. | ---------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.ConverterBase")() | Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. | -### Converters[¶](#converters "Permalink to this headline") +### Converters In addition to the base class, directory holds a few miscellaneous converters which are used frequently around the Operator flow. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.41/qiskit.opflow.double_commutator.md index 4640ca4e6e0..49bc33b09d3 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.double_commutator.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.opflow.double_commutator --- -# qiskit.opflow\.double\_commutator[¶](#qiskit-opflow-double-commutator "Permalink to this headline") +# qiskit.opflow\.double\_commutator -`double_commutator(op_a, op_b, op_c, sign=False)` +`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/utils.py "view source code") Compute symmetric double commutator of op\_a, op\_b and op\_c. See McWeeny chapter 13.6 Equation of motion methods (page 479) diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionBase.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionBase.md index 6e20f3dd36b..bc2d0ec43fe 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionBase.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.evolutions.EvolutionBase --- -# EvolutionBase[¶](#evolutionbase "Permalink to this headline") +# EvolutionBase -`EvolutionBase` +`EvolutionBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase"), `abc.ABC` @@ -22,7 +22,7 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope -`abstract EvolutionBase.convert(operator)` +`abstract EvolutionBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_base.py "view source code") Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionFactory.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionFactory.md index 43e2637530f..5c1a7c4d2e4 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolutionFactory.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.evolutions.EvolutionFactory --- -# EvolutionFactory[¶](#evolutionfactory "Permalink to this headline") +# EvolutionFactory -`EvolutionFactory` +`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Evolution algorithm bas -`static EvolutionFactory.build(operator=None)` +`static EvolutionFactory.build(operator=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolution_factory.py "view source code") A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolvedOp.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolvedOp.md index aab0d3d011b..988287f5196 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.EvolvedOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.evolutions.EvolvedOp --- -# EvolvedOp[¶](#evolvedop "Permalink to this headline") +# EvolvedOp -`EvolvedOp(primitive, coeff=1.0)` +`EvolvedOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -27,7 +27,7 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti -`EvolvedOp.add(other)` +`EvolvedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -47,7 +47,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`EvolvedOp.adjoint()` +`EvolvedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -63,7 +63,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`EvolvedOp.assign_parameters(param_dict)` +`EvolvedOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -83,7 +83,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`EvolvedOp.compose(other, permutation=None, front=False)` +`EvolvedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -111,7 +111,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`EvolvedOp.equals(other)` +`EvolvedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -131,7 +131,7 @@ A bool equal to the equality of self and other. -`EvolvedOp.eval(front=None)` +`EvolvedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -153,7 +153,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`EvolvedOp.log_i(massive=False)` +`EvolvedOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -165,7 +165,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`EvolvedOp.permute(permutation)` +`EvolvedOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Permutes the qubits of the operator. @@ -189,7 +189,7 @@ A new OperatorBase containing the permuted operator. -`EvolvedOp.primitive_strings()` +`EvolvedOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -205,7 +205,7 @@ A set of strings describing the primitives contained within the Operator. -`EvolvedOp.reduce()` +`EvolvedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -221,7 +221,7 @@ The reduced `OperatorBase`. -`EvolvedOp.tensor(other)` +`EvolvedOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -245,7 +245,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`EvolvedOp.to_instruction(massive=False)` +`EvolvedOp.to_instruction(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -257,7 +257,7 @@ Returns an `Instruction` equivalent to this Operator. -`EvolvedOp.to_matrix(massive=False)` +`EvolvedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -273,7 +273,7 @@ The NumPy `ndarray` equivalent to this Operator. -`EvolvedOp.to_matrix_op(massive=False)` +`EvolvedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/evolved_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.MatrixEvolution.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.MatrixEvolution.md index b89d9595633..71be240cd87 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.MatrixEvolution.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.evolutions.MatrixEvolution --- -# MatrixEvolution[¶](#matrixevolution "Permalink to this headline") +# MatrixEvolution -`MatrixEvolution` +`MatrixEvolution`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -22,7 +22,7 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi -`MatrixEvolution.convert(operator)` +`MatrixEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/matrix_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. This is done by converting the `EvolvedOp.primitive` to a `MatrixOp` and simply calling `.exp_i()` on that. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.PauliTrotterEvolution.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.PauliTrotterEvolution.md index c39ce53754f..5acd3002e0e 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution --- -# PauliTrotterEvolution[¶](#paulitrotterevolution "Permalink to this headline") +# PauliTrotterEvolution -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` +`PauliTrotterEvolution(trotter_mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -34,7 +34,7 @@ More specifically, we compute basis change circuits for each Pauli into a single -`PauliTrotterEvolution.convert(operator)` +`PauliTrotterEvolution.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing Trotterized evolutions equalling the exponentiation of -i \* operator. @@ -54,7 +54,7 @@ The converted operator. -`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)` +`PauliTrotterEvolution.evolution_for_abelian_paulisum(op_sum)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Evolution for abelian pauli sum @@ -66,7 +66,7 @@ Evolution for abelian pauli sum -`PauliTrotterEvolution.evolution_for_pauli(pauli_op)` +`PauliTrotterEvolution.evolution_for_pauli(pauli_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/pauli_trotter_evolution.py "view source code") Compute evolution Operator for a single Pauli using a `PauliBasisChange`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.QDrift.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.QDrift.md index e0156d52562..c24f7f74c40 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.QDrift.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.evolutions.QDrift --- -# QDrift[¶](#qdrift "Permalink to this headline") +# QDrift -`QDrift(reps=1)` +`QDrift(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") @@ -26,7 +26,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.convert(operator)` +`QDrift.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/qdrift.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Suzuki.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Suzuki.md index 186d8535545..aa15f120663 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Suzuki.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.evolutions.Suzuki --- -# Suzuki[¶](#suzuki "Permalink to this headline") +# Suzuki -`Suzuki(reps=1, order=2)` +`Suzuki(reps=1, order=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.trotterizations.trotterization_base.TrotterizationBase") @@ -29,7 +29,7 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q -`Suzuki.convert(operator)` +`Suzuki.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/suzuki.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Trotter.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Trotter.md index 0b054b01326..0d2699444e7 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.Trotter.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.evolutions.Trotter --- -# Trotter[¶](#trotter "Permalink to this headline") +# Trotter -`Trotter(reps=1)` +`Trotter(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotter.py "view source code") Bases: [`qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.trotterizations.suzuki.Suzuki") diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationBase.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationBase.md index d602ed8de6a..be305bd5371 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationBase.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.evolutions.TrotterizationBase --- -# TrotterizationBase[¶](#trotterizationbase "Permalink to this headline") +# TrotterizationBase -`TrotterizationBase(reps=1)` +`TrotterizationBase(reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Bases: [`qiskit.opflow.evolutions.evolution_base.EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.evolution_base.EvolutionBase") @@ -22,7 +22,7 @@ A base for Trotterization methods, algorithms for approximating exponentiations -`abstract TrotterizationBase.convert(operator)` +`abstract TrotterizationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_base.py "view source code") Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationFactory.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationFactory.md index 5659c942a91..3236f7fc463 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.evolutions.TrotterizationFactory --- -# TrotterizationFactory[¶](#trotterizationfactory "Permalink to this headline") +# TrotterizationFactory -`TrotterizationFactory` +`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory for conveniently creating TrotterizationBase instances. -`static TrotterizationFactory.build(mode='trotter', reps=1)` +`static TrotterizationFactory.build(mode='trotter', reps=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") A factory for conveniently creating TrotterizationBase instances. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.md b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.md index 656e4421c1b..901c1a93987 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.evolutions.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.evolutions.md @@ -1,8 +1,8 @@ -# qiskit.opflow\.evolutions[¶](#module-qiskit.opflow.evolutions "Permalink to this headline") +# qiskit.opflow\.evolutions -## Operator Evolutions ([`qiskit.opflow.evolutions`](#module-qiskit.opflow.evolutions "qiskit.opflow.evolutions"))[¶](#operator-evolutions-qiskit-opflow-evolutions "Permalink to this headline") +## Operator Evolutions ([`qiskit.opflow.evolutions`](#module-qiskit.opflow.evolutions "qiskit.opflow.evolutions")) Evolutions are converters which traverse an Operator tree, replacing any [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") e with a Schrodinger equation-style evolution [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. @@ -12,7 +12,7 @@ The [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.E Evolutions work with parameterized Operator coefficients, so `my_expectation.convert((t * H).exp_i())`, where t is a scalar or Terra Parameter and H is an Operator, will produce a [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equivalent to e^iHt. -### Evolution Base Class[¶](#evolution-base-class "Permalink to this headline") +### Evolution Base Class The EvolutionBase class gives an interface for algorithms to ask for Evolutions as execution settings. For example, if an algorithm contains an Operator evolution step within it, such as [`QAOA`](qiskit.algorithms.QAOA "qiskit.algorithms.QAOA"), the algorithm can give the opportunity for the user to pass an EvolutionBase of their choice to be used in that evolution step. @@ -20,7 +20,7 @@ The EvolutionBase class gives an interface for algorithms to ask for Evolutions | ---------------------------------------------------------------------------------------------------- | -------------------------------- | | [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.EvolutionBase")() | A base for Evolution converters. | -### Evolutions[¶](#evolutions "Permalink to this headline") +### Evolutions | | | | -------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -29,7 +29,7 @@ The EvolutionBase class gives an interface for algorithms to ask for Evolutions | [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution")() | Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. | | [`PauliTrotterEvolution`](qiskit.opflow.evolutions.PauliTrotterEvolution "qiskit.opflow.evolutions.PauliTrotterEvolution")(\[trotter\_mode, reps]) | An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. | -### Trotterizations[¶](#trotterizations "Permalink to this headline") +### Trotterizations | | | | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.AerPauliExpectation.md b/docs/api/qiskit/0.41/qiskit.opflow.expectations.AerPauliExpectation.md index 276e7a230f7..7ac480f3b1e 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.AerPauliExpectation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.expectations.AerPauliExpectation --- -# AerPauliExpectation[¶](#aerpauliexpectation "Permalink to this headline") +# AerPauliExpectation -`AerPauliExpectation` +`AerPauliExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -22,7 +22,7 @@ An Expectation converter for using Aer’s operator snapshot to take expectation -`AerPauliExpectation.compute_variance(exp_op)` +`AerPauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Compute the variance of the expectation estimator. Because Aer takes this expectation with matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`AerPauliExpectation.convert(operator)` +`AerPauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/aer_pauli_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.CVaRExpectation.md b/docs/api/qiskit/0.41/qiskit.opflow.expectations.CVaRExpectation.md index 9b2d13f7bbc..efc44282e24 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.CVaRExpectation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.expectations.CVaRExpectation --- -# CVaRExpectation[¶](#cvarexpectation "Permalink to this headline") +# CVaRExpectation -`CVaRExpectation(alpha, expectation=None)` +`CVaRExpectation(alpha, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -45,7 +45,7 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob -`CVaRExpectation.compute_variance(exp_op)` +`CVaRExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") Returns the variance of the CVaR calculation @@ -71,7 +71,7 @@ exp\_op. -`CVaRExpectation.convert(operator)` +`CVaRExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/cvar_expectation.py "view source code") Return an expression that computes the CVaR expectation upon calling `eval`. :type operator: [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") :param operator: The operator to convert. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationBase.md b/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationBase.md index b628d1626e5..f0dd5f714b1 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationBase.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.expectations.ExpectationBase --- -# ExpectationBase[¶](#expectationbase "Permalink to this headline") +# ExpectationBase -`ExpectationBase` +`ExpectationBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -22,7 +22,7 @@ A base for Expectation value converters. Expectations are converters which enabl -`abstract ExpectationBase.compute_variance(exp_op)` +`abstract ExpectationBase.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") Compute the variance of the expectation estimator. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`abstract ExpectationBase.convert(operator)` +`abstract ExpectationBase.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_base.py "view source code") Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationFactory.md b/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationFactory.md index 7d4faa4cc14..422b0f08822 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.ExpectationFactory.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.expectations.ExpectationFactory --- -# ExpectationFactory[¶](#expectationfactory "Permalink to this headline") +# ExpectationFactory -`ExpectationFactory` +`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A factory class for convenient automatic selection of an Expectation based on th -`static ExpectationFactory.build(operator, backend=None, include_custom=True)` +`static ExpectationFactory.build(operator, backend=None, include_custom=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/expectation_factory.py "view source code") A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.MatrixExpectation.md b/docs/api/qiskit/0.41/qiskit.opflow.expectations.MatrixExpectation.md index 094f041511a..3c83c73b555 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.MatrixExpectation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.expectations.MatrixExpectation --- -# MatrixExpectation[¶](#matrixexpectation "Permalink to this headline") +# MatrixExpectation -`MatrixExpectation` +`MatrixExpectation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -22,7 +22,7 @@ An Expectation converter which converts Operator measurements to be matrix-based -`MatrixExpectation.compute_variance(exp_op)` +`MatrixExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") Compute the variance of the expectation estimator. Because this expectation works by matrix multiplication, the estimation is exact and the variance is always 0, but we need to return those values in a way which matches the Operator’s structure. @@ -42,7 +42,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`MatrixExpectation.convert(operator)` +`MatrixExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/matrix_expectation.py "view source code") Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.PauliExpectation.md b/docs/api/qiskit/0.41/qiskit.opflow.expectations.PauliExpectation.md index 05fa8650813..c945ea94df6 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.PauliExpectation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.expectations.PauliExpectation --- -# PauliExpectation[¶](#pauliexpectation "Permalink to this headline") +# PauliExpectation -`PauliExpectation(group_paulis=True)` +`PauliExpectation(group_paulis=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") Bases: [`qiskit.opflow.expectations.expectation_base.ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.expectation_base.ExpectationBase") @@ -26,7 +26,7 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme -`PauliExpectation.compute_variance(exp_op)` +`PauliExpectation.compute_variance(exp_op)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") Compute the variance of the expectation estimator. @@ -46,7 +46,7 @@ The variances or lists thereof (if exp\_op contains ListOps) of the expectation -`PauliExpectation.convert(operator)` +`PauliExpectation.convert(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/expectations/pauli_expectation.py "view source code") Accepts an Operator and returns a new Operator with the Pauli measurements replaced by diagonal Pauli post-rotation based measurements so they can be evaluated by sampling and averaging. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.expectations.md b/docs/api/qiskit/0.41/qiskit.opflow.expectations.md index 7fbfc0beef7..40f57dfa261 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.expectations.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.expectations.md @@ -1,12 +1,12 @@ -# qiskit.opflow\.expectations[¶](#module-qiskit.opflow.expectations "Permalink to this headline") +# qiskit.opflow\.expectations -## Expectations ([`qiskit.opflow.expectations`](#module-qiskit.opflow.expectations "qiskit.opflow.expectations"))[¶](#expectations-qiskit-opflow-expectations "Permalink to this headline") +## Expectations ([`qiskit.opflow.expectations`](#module-qiskit.opflow.expectations "qiskit.opflow.expectations")) Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") to convert it to a diagonal measurement and circuit pre-rotations to append to the state, and sample this circuit on Quantum hardware with a [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler"). All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. -### Expectation Base Class[¶](#expectation-base-class "Permalink to this headline") +### Expectation Base Class The ExpectationBase class gives an interface for algorithms to ask for Expectations as execution settings. For example, if an algorithm contains an expectation value step within it, such as [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE"), the algorithm can give the opportunity for the user to pass an ExpectationBase of their choice to be used in that expectation value step. @@ -14,7 +14,7 @@ The ExpectationBase class gives an interface for algorithms to ask for Expectati | -------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | | [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.ExpectationBase")() | A base for Expectation value converters. | -### Expectations[¶](#expectations "Permalink to this headline") +### Expectations | | | | ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitGradient.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitGradient.md index ccd40bc7c97..edf49889deb 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitGradient.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.gradients.CircuitGradient --- -# CircuitGradient[¶](#circuitgradient "Permalink to this headline") +# CircuitGradient -`CircuitGradient` +`CircuitGradient`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract CircuitGradient.convert(operator, params=None)` +`abstract CircuitGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_gradients/circuit_gradient.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitQFI.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitQFI.md index f67da97feb9..761a18e157c 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.CircuitQFI.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.gradients.CircuitQFI --- -# CircuitQFI[¶](#circuitqfi "Permalink to this headline") +# CircuitQFI -`CircuitQFI` +`CircuitQFI`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - -`abstract CircuitQFI.convert(operator, params)` +`abstract CircuitQFI.convert(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/circuit_qfis/circuit_qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.DerivativeBase.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.DerivativeBase.md index 66d0b6aad74..0549fc2ae7a 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.DerivativeBase.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.gradients.DerivativeBase --- -# DerivativeBase[¶](#derivativebase "Permalink to this headline") +# DerivativeBase -`DerivativeBase` +`DerivativeBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") Bases: [`qiskit.opflow.converters.converter_base.ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.converter_base.ConverterBase") @@ -28,7 +28,7 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat -`abstract DerivativeBase.convert(operator, params=None)` +`abstract DerivativeBase.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") **Parameters** @@ -51,7 +51,7 @@ An operator whose evaluation yields the gradient, Hessian or QFI. -`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)` +`DerivativeBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None, expectation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. This callable can be used as gradient function for optimizers. @@ -75,7 +75,7 @@ Function to compute a gradient, Hessian or QFI. The function takes an iterable a -`static DerivativeBase.parameter_expression_grad(param_expr, param)` +`static DerivativeBase.parameter_expression_grad(param_expr, param)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/derivative_base.py "view source code") Get the derivative of a parameter expression w\.r.t. the given parameter. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.Gradient.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.Gradient.md index d05f5285678..3294ac63cb5 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.Gradient.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.gradients.Gradient --- -# Gradient[¶](#gradient "Permalink to this headline") +# Gradient -`Gradient(grad_method='param_shift', **kwargs)` +`Gradient(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") @@ -31,7 +31,7 @@ Convert an operator expression to the first-order gradient. -`Gradient.convert(operator, params=None)` +`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") **Parameters** @@ -55,7 +55,7 @@ An operator whose evaluation yields the Gradient. -`Gradient.get_gradient(operator, params)` +`Gradient.get_gradient(operator, params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient.py "view source code") Get the gradient for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.GradientBase.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.GradientBase.md index a702e8ca358..6b7e9407b3b 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.GradientBase.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.gradients.GradientBase --- -# GradientBase[¶](#gradientbase "Permalink to this headline") +# GradientBase -`GradientBase(grad_method='param_shift', **kwargs)` +`GradientBase(grad_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/gradient_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.Hessian.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.Hessian.md index 8ed3d7a4bd1..8d4591e2265 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.Hessian.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.gradients.Hessian --- -# Hessian[¶](#hessian "Permalink to this headline") +# Hessian -`Hessian(hess_method='param_shift', **kwargs)` +`Hessian(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") Bases: [`qiskit.opflow.gradients.hessian_base.HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.hessian_base.HessianBase") @@ -31,7 +31,7 @@ Compute the Hessian of an expected value. -`Hessian.convert(operator, params=None)` +`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") **Parameters** @@ -50,7 +50,7 @@ An operator whose evaluation yields the Hessian -`Hessian.get_hessian(operator, params=None)` +`Hessian.get_hessian(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian.py "view source code") Get the Hessian for the given operator w\.r.t. the given parameters diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.HessianBase.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.HessianBase.md index e5b8261233c..808e372cdf0 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.HessianBase.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.gradients.HessianBase --- -# HessianBase[¶](#hessianbase "Permalink to this headline") +# HessianBase -`HessianBase(hess_method='param_shift', **kwargs)` +`HessianBase(hess_method='param_shift', **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/hessian_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.NaturalGradient.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.NaturalGradient.md index 9893b423ad2..c9f06c5223a 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.NaturalGradient.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.gradients.NaturalGradient --- -# NaturalGradient[¶](#naturalgradient "Permalink to this headline") +# NaturalGradient -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: [`qiskit.opflow.gradients.gradient_base.GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.gradient_base.GradientBase") @@ -39,7 +39,7 @@ where R(x) represents the penalization term. -`NaturalGradient.convert(operator, params=None)` +`NaturalGradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") **Parameters** @@ -64,7 +64,7 @@ An operator whose evaluation yields the NaturalGradient. -`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)` +`static NaturalGradient.nat_grad_combo_fn(x, regularization=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/natural_gradient.py "view source code") Natural Gradient Function Implementation. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFI.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFI.md index 4bdc9be564a..cbdba232293 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFI.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.gradients.QFI --- -# QFI[¶](#qfi "Permalink to this headline") +# QFI -`QFI(qfi_method='lin_comb_full')` +`QFI(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi.py "view source code") Bases: [`qiskit.opflow.gradients.qfi_base.QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.qfi_base.QFIBase") @@ -37,7 +37,7 @@ $$ -`QFI.convert(operator, params=None)` +`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFIBase.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFIBase.md index eba4cab30a3..debdbfbda2d 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.QFIBase.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.gradients.QFIBase --- -# QFIBase[¶](#qfibase "Permalink to this headline") +# QFIBase -`QFIBase(qfi_method='lin_comb_full')` +`QFIBase(qfi_method='lin_comb_full')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/gradients/qfi_base.py "view source code") Bases: [`qiskit.opflow.gradients.derivative_base.DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.derivative_base.DerivativeBase") diff --git a/docs/api/qiskit/0.41/qiskit.opflow.gradients.md b/docs/api/qiskit/0.41/qiskit.opflow.gradients.md index 42643fee6ed..e4558f4e2ea 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.gradients.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.gradients.md @@ -1,8 +1,8 @@ -# qiskit.opflow\.gradients[¶](#module-qiskit.opflow.gradients "Permalink to this headline") +# qiskit.opflow\.gradients -## Gradients ([`qiskit.opflow.gradients`](#module-qiskit.opflow.gradients "qiskit.opflow.gradients"))[¶](#gradients-qiskit-opflow-gradients "Permalink to this headline") +## Gradients ([`qiskit.opflow.gradients`](#module-qiskit.opflow.gradients "qiskit.opflow.gradients")) Given an operator that represents either a quantum state resp. an expectation value, the gradient framework enables the evaluation of gradients, natural gradients, Hessians, as well as the Quantum Fisher Information. @@ -85,7 +85,7 @@ nat_grad = NaturalGradient(grad_method='lin_comb, The derivative classes come with a gradient\_wrapper() function which returns the corresponding callable and are thus compatible with the optimizers. -### Base Classes[¶](#base-classes "Permalink to this headline") +### Base Classes | | | | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | @@ -94,14 +94,14 @@ The derivative classes come with a gradient\_wrapper() function which returns th | [`HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.HessianBase")(\[hess\_method]) | Base class for the Hessian of an expected value. | | [`QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.QFIBase")(\[qfi\_method]) | Base class for Quantum Fisher Information (QFI). | -### Converters[¶](#converters "Permalink to this headline") +### Converters | | | | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | | [`CircuitGradient`](qiskit.opflow.gradients.CircuitGradient "qiskit.opflow.gradients.CircuitGradient")() | Circuit to gradient operator converter. | | [`CircuitQFI`](qiskit.opflow.gradients.CircuitQFI "qiskit.opflow.gradients.CircuitQFI")() | Circuit to Quantum Fisher Information operator converter. | -### Derivatives[¶](#derivatives "Permalink to this headline") +### Derivatives | | | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | diff --git a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ComposedOp.md b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ComposedOp.md index b5dcff76652..8431a1a737d 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ComposedOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ComposedOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.list_ops.ComposedOp --- -# ComposedOp[¶](#composedop "Permalink to this headline") +# ComposedOp -`ComposedOp(oplist, coeff=1.0, abelian=False)` +`ComposedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing compositions of Operators. Often Operators canno -`ComposedOp.adjoint()` +`ComposedOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -44,7 +44,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ComposedOp.compose(other, permutation=None, front=False)` +`ComposedOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -72,7 +72,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`ComposedOp.eval(front=None)` +`ComposedOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -100,7 +100,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ComposedOp.non_distributive_reduce()` +`ComposedOp.non_distributive_reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Reduce without attempting to expand all distributive compositions. @@ -116,7 +116,7 @@ The reduced Operator. -`ComposedOp.reduce()` +`ComposedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -132,7 +132,7 @@ The reduced `OperatorBase`. -`ComposedOp.to_circuit()` +`ComposedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Returns the quantum circuit, representing the composed operator. @@ -152,7 +152,7 @@ The circuit representation of the composed operator. -`ComposedOp.to_matrix(massive=False)` +`ComposedOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/composed_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ListOp.md b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ListOp.md index 68369c5b4a9..d45f5857737 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ListOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.ListOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.list_ops.ListOp --- -# ListOp[¶](#listop "Permalink to this headline") +# ListOp -`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` +`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -37,7 +37,7 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the -`ListOp.add(other)` +`ListOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -57,7 +57,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`ListOp.adjoint()` +`ListOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -73,7 +73,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`ListOp.assign_parameters(param_dict)` +`ListOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -93,7 +93,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`ListOp.compose(other, permutation=None, front=False)` +`ListOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -121,7 +121,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`static ListOp.default_combo_fn(x)` +`static ListOp.default_combo_fn(x)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") ListOp default combo function i.e. lambda x: x @@ -133,7 +133,7 @@ ListOp default combo function i.e. lambda x: x -`ListOp.equals(other)` +`ListOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -153,7 +153,7 @@ A bool equal to the equality of self and other. -`ListOp.eval(front=None)` +`ListOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -181,7 +181,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`ListOp.exp_i()` +`ListOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). @@ -193,7 +193,7 @@ Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*o -`ListOp.log_i(massive=False)` +`ListOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. For proper ListOps, applies `log_i` to all ops in oplist. @@ -205,7 +205,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`ListOp.mul(scalar)` +`ListOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -225,7 +225,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`ListOp.permute(permutation)` +`ListOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Permute the qubits of the operator. @@ -249,7 +249,7 @@ A new ListOp representing the permuted operator. -`ListOp.power(exponent)` +`ListOp.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return Operator composed with self multiple times, overloaded by `**`. @@ -261,7 +261,7 @@ Return Operator composed with self multiple times, overloaded by `**`. -`ListOp.primitive_strings()` +`ListOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -277,7 +277,7 @@ A set of strings describing the primitives contained within the Operator. -`ListOp.reduce()` +`ListOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -293,7 +293,7 @@ The reduced `OperatorBase`. -`ListOp.tensor(other)` +`ListOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -317,7 +317,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`ListOp.tensorpower(other)` +`ListOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -337,7 +337,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`ListOp.to_circuit_op()` +`ListOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. @@ -349,7 +349,7 @@ Returns an equivalent Operator composed of only QuantumCircuit-based primitives, -`ListOp.to_matrix(massive=False)` +`ListOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -365,7 +365,7 @@ The NumPy `ndarray` equivalent to this Operator. -`ListOp.to_matrix_op(massive=False)` +`ListOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -377,7 +377,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`ListOp.to_pauli_op(massive=False)` +`ListOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. @@ -389,7 +389,7 @@ Returns an equivalent Operator composed of only Pauli-based primitives, such as -`ListOp.to_spmatrix()` +`ListOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. @@ -405,7 +405,7 @@ CSR sparse matrix representation of the Operator, or List thereof. -`ListOp.traverse(convert_fn, coeff=None)` +`ListOp.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/list_op.py "view source code") Apply the convert\_fn to each node in the oplist. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.SummedOp.md b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.SummedOp.md index 731e73eac3c..90339c1a490 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.SummedOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.SummedOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.list_ops.SummedOp --- -# SummedOp[¶](#summedop "Permalink to this headline") +# SummedOp -`SummedOp(oplist, coeff=1.0, abelian=False)` +`SummedOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff -`SummedOp.add(other)` +`SummedOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator addition of `self` and `other`, overloaded by `+`. @@ -52,7 +52,7 @@ A `SummedOp` equivalent to the sum of self and other. -`SummedOp.collapse_summands()` +`SummedOp.collapse_summands()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Return Operator by simplifying duplicate operators. @@ -70,7 +70,7 @@ A simplified `SummedOp` equivalent to self. -`SummedOp.equals(other)` +`SummedOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Check if other is equal to self. @@ -104,7 +104,7 @@ True -`SummedOp.reduce()` +`SummedOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Try collapsing list or trees of sums. @@ -122,7 +122,7 @@ A collapsed version of self, if possible. -`SummedOp.to_circuit()` +`SummedOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Returns the quantum circuit, representing the SummedOp. In the first step, the SummedOp is converted to MatrixOp. This is straightforward for most operators, but it is not supported for operators containing parameterized PrimitiveOps (in that case, OpflowError is raised). In the next step, the MatrixOp representation of SummedOp is converted to circuit. In most cases, if the summands themselves are unitary operators, the SummedOp itself is non-unitary and can not be converted to circuit. In that case, ExtensionError is raised in the underlying modules. @@ -143,7 +143,7 @@ The circuit representation of the summed operator. -`SummedOp.to_matrix_op(massive=False)` +`SummedOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. @@ -155,7 +155,7 @@ Returns an equivalent Operator composed of only NumPy-based primitives, such as -`SummedOp.to_pauli_op(massive=False)` +`SummedOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/summed_op.py "view source code") Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.TensoredOp.md b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.TensoredOp.md index ac70f5eb945..4c517541af1 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.TensoredOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.TensoredOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.list_ops.TensoredOp --- -# TensoredOp[¶](#tensoredop "Permalink to this headline") +# TensoredOp -`TensoredOp(oplist, coeff=1.0, abelian=False)` +`TensoredOp(oplist, coeff=1.0, abelian=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Bases: [`qiskit.opflow.list_ops.list_op.ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.list_op.ListOp") @@ -28,7 +28,7 @@ A class for lazily representing tensor products of Operators. Often Operators ca -`TensoredOp.eval(front=None)` +`TensoredOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -56,7 +56,7 @@ The output of the `oplist` Operators’ evaluation function, combined with the ` -`TensoredOp.reduce()` +`TensoredOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -72,7 +72,7 @@ The reduced `OperatorBase`. -`TensoredOp.tensor(other)` +`TensoredOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`TensoredOp.to_circuit()` +`TensoredOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Returns the quantum circuit, representing the tensored operator. @@ -116,7 +116,7 @@ The circuit representation of the tensored operator. -`TensoredOp.to_matrix(massive=False)` +`TensoredOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/list_ops/tensored_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.md b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.md index b5020315ea8..71b2cd119a1 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.list_ops.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.list_ops.md @@ -1,8 +1,8 @@ -# qiskit.opflow\.list\_ops[¶](#module-qiskit.opflow.list_ops "Permalink to this headline") +# qiskit.opflow\.list\_ops -## List Operators ([`qiskit.opflow.list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops"))[¶](#list-operators-qiskit-opflow-list-ops "Permalink to this headline") +## List Operators ([`qiskit.opflow.list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops")) List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or `combo_fn` defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). For example, a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") has an addition-based `combo_fn`, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")’s evaluation. In theory, this `combo_fn` can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling [`to_matrix()`](qiskit.opflow.list_ops.ListOp#to_matrix "qiskit.opflow.list_ops.ListOp.to_matrix") on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators’ underlying function is combined to form the underlying Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). In this way, the [`list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops") are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. @@ -23,7 +23,7 @@ You’ll encounter the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.l Combination functions do not always behave predictably, and you must understand the conversions you’re making when you working with [`list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops"). Most notably - sampling a sum of two circuits on Quantum hardware does not incorporate interference between the wavefunctions! In this case, we’re sending our State functions through a depolarizing channel before adding them, rather than adding them directly before the measurement. -### List Operators[¶](#list-operators "Permalink to this headline") +### List Operators | | | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.CircuitOp.md b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.CircuitOp.md index c91e9543c3e..062a69e7163 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.CircuitOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.CircuitOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.primitive_ops.CircuitOp --- -# CircuitOp[¶](#circuitop "Permalink to this headline") +# CircuitOp -`CircuitOp(primitive, coeff=1.0)` +`CircuitOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. -`CircuitOp.add(other)` +`CircuitOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitOp.adjoint()` +`CircuitOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitOp.assign_parameters(param_dict)` +`CircuitOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -88,7 +88,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitOp.compose(other, permutation=None, front=False)` +`CircuitOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -116,7 +116,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`CircuitOp.equals(other)` +`CircuitOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`CircuitOp.eval(front=None)` +`CircuitOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`CircuitOp.permute(permutation)` +`CircuitOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Permute the qubits of the circuit. @@ -178,7 +178,7 @@ A new CircuitOp containing the permuted circuit. -`CircuitOp.primitive_strings()` +`CircuitOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -194,7 +194,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitOp.reduce()` +`CircuitOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -210,7 +210,7 @@ The reduced `OperatorBase`. -`CircuitOp.tensor(other)` +`CircuitOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -234,7 +234,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitOp.to_circuit()` +`CircuitOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -246,7 +246,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`CircuitOp.to_circuit_op()` +`CircuitOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -258,7 +258,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`CircuitOp.to_instruction()` +`CircuitOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -270,7 +270,7 @@ Returns an `Instruction` equivalent to this Operator. -`CircuitOp.to_matrix(massive=False)` +`CircuitOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/circuit_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.MatrixOp.md b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.MatrixOp.md index 49761dd72d9..c20e731be22 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.MatrixOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.MatrixOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.primitive_ops.MatrixOp --- -# MatrixOp[¶](#matrixop "Permalink to this headline") +# MatrixOp -`MatrixOp(primitive, coeff=1.0)` +`MatrixOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu -`MatrixOp.add(other)` +`MatrixOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`MatrixOp.adjoint()` +`MatrixOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`MatrixOp.compose(other, permutation=None, front=False)` +`MatrixOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`MatrixOp.equals(other)` +`MatrixOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`MatrixOp.eval(front=None)` +`MatrixOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`MatrixOp.exp_i()` +`MatrixOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H -`MatrixOp.permute(permutation=None)` +`MatrixOp.permute(permutation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Creates a new MatrixOp that acts on the permuted qubits. @@ -174,7 +174,7 @@ A new MatrixOp representing the permuted operator. -`MatrixOp.primitive_strings()` +`MatrixOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -190,7 +190,7 @@ A set of strings describing the primitives contained within the Operator. -`MatrixOp.tensor(other)` +`MatrixOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -214,7 +214,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`MatrixOp.to_instruction()` +`MatrixOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -226,7 +226,7 @@ Returns an `Instruction` equivalent to this Operator. -`MatrixOp.to_matrix(massive=False)` +`MatrixOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -242,7 +242,7 @@ The NumPy `ndarray` equivalent to this Operator. -`MatrixOp.to_matrix_op(massive=False)` +`MatrixOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/matrix_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliOp.md b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliOp.md index e588397e62c..680201e9cf7 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.primitive_ops.PauliOp --- -# PauliOp[¶](#pauliop "Permalink to this headline") +# PauliOp -`PauliOp(primitive, coeff=1.0)` +`PauliOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -31,7 +31,7 @@ Class for Operators backed by Terra’s `Pauli` module. -`PauliOp.add(other)` +`PauliOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -51,7 +51,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliOp.adjoint()` +`PauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -67,7 +67,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliOp.compose(other, permutation=None, front=False)` +`PauliOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -95,7 +95,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliOp.equals(other)` +`PauliOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -115,7 +115,7 @@ A bool equal to the equality of self and other. -`PauliOp.eval(front=None)` +`PauliOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliOp.exp_i()` +`PauliOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -149,7 +149,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`PauliOp.permute(permutation)` +`PauliOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Permutes the sequence of Pauli matrices. @@ -173,7 +173,7 @@ A new PauliOp representing the permuted operator. For operator (X ^ Y ^ Z) and i -`PauliOp.primitive_strings()` +`PauliOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -189,7 +189,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliOp.tensor(other)` +`PauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -213,7 +213,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliOp.to_circuit()` +`PauliOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -225,7 +225,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PauliOp.to_instruction()` +`PauliOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -237,7 +237,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliOp.to_matrix(massive=False)` +`PauliOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -253,7 +253,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliOp.to_pauli_op(massive=False)` +`PauliOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -265,7 +265,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliOp.to_spmatrix()` +`PauliOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_op.py "view source code") Returns SciPy sparse matrix representation of the Operator. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliSumOp.md b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliSumOp.md index 3cfd78c7e60..4ecb200319a 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliSumOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PauliSumOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.primitive_ops.PauliSumOp --- -# PauliSumOp[¶](#paulisumop "Permalink to this headline") +# PauliSumOp -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp") @@ -32,7 +32,7 @@ Class for Operators backed by Terra’s `SparsePauliOp` class. -`PauliSumOp.add(other)` +`PauliSumOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -52,7 +52,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PauliSumOp.adjoint()` +`PauliSumOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -68,7 +68,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PauliSumOp.compose(other, permutation=None, front=False)` +`PauliSumOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -96,7 +96,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PauliSumOp.equals(other)` +`PauliSumOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -116,7 +116,7 @@ A bool equal to the equality of self and other. -`PauliSumOp.eval(front=None)` +`PauliSumOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -138,7 +138,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PauliSumOp.exp_i()` +`PauliSumOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a `CircuitOp` equivalent to e^-iH for this operator H. @@ -150,7 +150,7 @@ Return a `CircuitOp` equivalent to e^-iH for this operator H. -`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0, dtype=)` +`classmethod PauliSumOp.from_list(pauli_list, coeff=1.0, dtype=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] @@ -172,7 +172,7 @@ The PauliSumOp constructed from the pauli\_list. -`PauliSumOp.is_hermitian()` +`PauliSumOp.is_hermitian()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return True if the operator is hermitian. @@ -182,7 +182,7 @@ Returns: Boolean value -`PauliSumOp.is_zero()` +`PauliSumOp.is_zero()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return this operator is zero operator or not. @@ -194,7 +194,7 @@ Return this operator is zero operator or not. -`PauliSumOp.matrix_iter(sparse=False)` +`PauliSumOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a matrix representation iterator. @@ -216,7 +216,7 @@ MatrixIterator -`PauliSumOp.mul(scalar)` +`PauliSumOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -236,7 +236,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PauliSumOp.permute(permutation)` +`PauliSumOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Permutes the sequence of `PauliSumOp`. @@ -260,7 +260,7 @@ A new PauliSumOp representing the permuted operator. For operator (X ^ Y ^ Z) an -`PauliSumOp.primitive_strings()` +`PauliSumOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -276,7 +276,7 @@ A set of strings describing the primitives contained within the Operator. -`PauliSumOp.reduce(atol=None, rtol=None)` +`PauliSumOp.reduce(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Simplify the primitive `SparsePauliOp`. @@ -297,7 +297,7 @@ The simplified `PauliSumOp`. -`PauliSumOp.tensor(other)` +`PauliSumOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -321,7 +321,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PauliSumOp.to_instruction()` +`PauliSumOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -333,7 +333,7 @@ Returns an `Instruction` equivalent to this Operator. -`PauliSumOp.to_matrix(massive=False)` +`PauliSumOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -349,7 +349,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PauliSumOp.to_pauli_op(massive=False)` +`PauliSumOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. @@ -361,7 +361,7 @@ Returns a sum of `PauliOp` s equivalent to this Operator. -`PauliSumOp.to_spmatrix()` +`PauliSumOp.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Returns SciPy sparse matrix representation of the `PauliSumOp`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PrimitiveOp.md b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PrimitiveOp.md index e799983bc7a..c8fec82620d 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PrimitiveOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.PrimitiveOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp --- -# PrimitiveOp[¶](#primitiveop "Permalink to this headline") +# PrimitiveOp -`PrimitiveOp(primitive, coeff=1.0)` +`PrimitiveOp(primitive, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -29,7 +29,7 @@ Note that all mathematical methods are not in-place, meaning that they return a -`PrimitiveOp.add(other)` +`PrimitiveOp.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -49,7 +49,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`PrimitiveOp.adjoint()` +`PrimitiveOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -65,7 +65,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`PrimitiveOp.assign_parameters(param_dict)` +`PrimitiveOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -85,7 +85,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`PrimitiveOp.compose(other, permutation=None, front=False)` +`PrimitiveOp.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. @@ -113,7 +113,7 @@ An `OperatorBase` equivalent to the function composition of self and other. -`PrimitiveOp.equals(other)` +`PrimitiveOp.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -133,7 +133,7 @@ A bool equal to the equality of self and other. -`PrimitiveOp.eval(front=None)` +`PrimitiveOp.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -155,7 +155,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`PrimitiveOp.exp_i()` +`PrimitiveOp.exp_i()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return Operator exponentiation, equaling e^(-i \* op) @@ -167,7 +167,7 @@ Return Operator exponentiation, equaling e^(-i \* op) -`PrimitiveOp.log_i(massive=False)` +`PrimitiveOp.log_i(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function is the effective inverse of exp\_i, equivalent to finding the Hermitian Operator which produces self when exponentiated. @@ -179,7 +179,7 @@ Return a `MatrixOp` equivalent to log(H)/-i for this operator H. This function i -`PrimitiveOp.mul(scalar)` +`PrimitiveOp.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -199,7 +199,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`PrimitiveOp.permute(permutation)` +`PrimitiveOp.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Permutes the qubits of the operator. @@ -223,7 +223,7 @@ A new OperatorBase containing the permuted operator. -`PrimitiveOp.primitive_strings()` +`PrimitiveOp.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -239,7 +239,7 @@ A set of strings describing the primitives contained within the Operator. -`PrimitiveOp.reduce()` +`PrimitiveOp.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -255,7 +255,7 @@ The reduced `OperatorBase`. -`PrimitiveOp.tensor(other)` +`PrimitiveOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like @@ -279,7 +279,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`PrimitiveOp.tensorpower(other)` +`PrimitiveOp.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -299,7 +299,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`PrimitiveOp.to_circuit()` +`PrimitiveOp.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `QuantumCircuit` equivalent to this Operator. @@ -311,7 +311,7 @@ Returns a `QuantumCircuit` equivalent to this Operator. -`PrimitiveOp.to_circuit_op()` +`PrimitiveOp.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -323,7 +323,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`PrimitiveOp.to_instruction()` +`PrimitiveOp.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns an `Instruction` equivalent to this Operator. @@ -335,7 +335,7 @@ Returns an `Instruction` equivalent to this Operator. -`PrimitiveOp.to_matrix(massive=False)` +`PrimitiveOp.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -351,7 +351,7 @@ The NumPy `ndarray` equivalent to this Operator. -`PrimitiveOp.to_matrix_op(massive=False)` +`PrimitiveOp.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a `MatrixOp` equivalent to this Operator. @@ -363,7 +363,7 @@ Returns a `MatrixOp` equivalent to this Operator. -`PrimitiveOp.to_pauli_op(massive=False)` +`PrimitiveOp.to_pauli_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/primitive_op.py "view source code") Returns a sum of `PauliOp` s equivalent to this Operator. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md index c3b99adbef9..181208b7e3d 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.TaperedPauliSumOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp --- -# TaperedPauliSumOp[¶](#taperedpaulisumop "Permalink to this headline") +# TaperedPauliSumOp -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` +`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: [`qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.pauli_sum_op.PauliSumOp") @@ -32,7 +32,7 @@ Class for PauliSumOp after tapering -`TaperedPauliSumOp.assign_parameters(param_dict)` +`TaperedPauliSumOp.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.Z2Symmetries.md b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.Z2Symmetries.md index d844da78870..b7aef50f839 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.Z2Symmetries.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.Z2Symmetries.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries --- -# Z2Symmetries[¶](#z2symmetries "Permalink to this headline") +# Z2Symmetries -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)` +`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None, tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Bases: `object` @@ -34,7 +34,7 @@ Z2 Symmetries -`Z2Symmetries.consistent_tapering(operator)` +`Z2Symmetries.consistent_tapering(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Tapering the operator with the same manner of how this tapered operator is created. i.e., using the same Cliffords and tapering values. @@ -58,7 +58,7 @@ The tapered operator -`Z2Symmetries.convert_clifford(operator)` +`Z2Symmetries.convert_clifford(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") This method operates the first part of the tapering. It converts the operator by composing it with the clifford unitaries defined in the current symmetry. @@ -82,7 +82,7 @@ This method operates the first part of the tapering. It converts the operator by -`Z2Symmetries.copy()` +`Z2Symmetries.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Get a copy of self. :rtype: [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.tapered_pauli_sum_op.Z2Symmetries") :returns: copy @@ -90,7 +90,7 @@ Get a copy of self. :rtype: [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symme -`classmethod Z2Symmetries.find_Z2_symmetries(operator)` +`classmethod Z2Symmetries.find_Z2_symmetries(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Finds Z2 Pauli-type symmetries of an Operator. @@ -106,7 +106,7 @@ a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. -`Z2Symmetries.is_empty()` +`Z2Symmetries.is_empty()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not @@ -114,7 +114,7 @@ Check the z2\_symmetries is empty or not. :rtype: `bool` :returns: Empty or not -`Z2Symmetries.taper(operator)` +`Z2Symmetries.taper(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. The tapering\_values will be stored into the resulted operator for a record. @@ -142,7 +142,7 @@ If tapering\_values is None -`Z2Symmetries.taper_clifford(operator)` +`Z2Symmetries.taper_clifford(operator)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/primitive_ops/tapered_pauli_sum_op.py "view source code") This method operates the second part of the tapering. This function assumes that the input operators have already been transformed using [`convert_clifford()`](qiskit.opflow.primitive_ops.Z2Symmetries#convert_clifford "qiskit.opflow.primitive_ops.Z2Symmetries.convert_clifford"). The redundant qubits due to the symmetries are dropped and replaced by their two possible eigenvalues. The tapering\_values will be stored into the resulted operator for a record. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.md b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.md index 62376a118bc..356f54afb31 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.primitive_ops.md @@ -1,8 +1,8 @@ -# qiskit.opflow\.primitive\_ops[¶](#module-qiskit.opflow.primitive_ops "Permalink to this headline") +# qiskit.opflow\.primitive\_ops -## Primitive Operators ([`qiskit.opflow.primitive_ops`](#module-qiskit.opflow.primitive_ops "qiskit.opflow.primitive_ops"))[¶](#primitive-operators-qiskit-opflow-primitive-ops "Permalink to this headline") +## Primitive Operators ([`qiskit.opflow.primitive_ops`](#module-qiskit.opflow.primitive_ops "qiskit.opflow.primitive_ops")) Operators are defined to be functions which take State functions to State functions. @@ -12,7 +12,7 @@ PrimitiveOps are the classes for representing basic Operators, backed by computa All mathematical methods are not in-place, meaning that they return a new object, but the underlying primitives are not copied. -### Primitive Operators[¶](#primitive-operators "Permalink to this headline") +### Primitive Operators | | | | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | @@ -23,7 +23,7 @@ PrimitiveOps are the classes for representing basic Operators, backed by computa | [`PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.PauliSumOp")(primitive\[, coeff, grouping\_type]) | Class for Operators backed by Terra's `SparsePauliOp` class. | | [`TaperedPauliSumOp`](qiskit.opflow.primitive_ops.TaperedPauliSumOp "qiskit.opflow.primitive_ops.TaperedPauliSumOp")(primitive, z2\_symmetries) | Class for PauliSumOp after tapering | -### Symmetries[¶](#symmetries "Permalink to this headline") +### Symmetries | | | | --------------------------------------------------------------------------------------------------------------------------------------- | ------------- | diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CVaRMeasurement.md b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CVaRMeasurement.md index cd95a0d9977..61328732ac2 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CVaRMeasurement.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CVaRMeasurement.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.state_fns.CVaRMeasurement --- -# CVaRMeasurement[¶](#cvarmeasurement "Permalink to this headline") +# CVaRMeasurement -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: [`qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn") @@ -38,7 +38,7 @@ Used in `CVaRExpectation`, see there for more details. -`CVaRMeasurement.add(other)` +`CVaRMeasurement.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -58,7 +58,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CVaRMeasurement.adjoint()` +`CVaRMeasurement.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") The adjoint of a CVaRMeasurement is not defined. @@ -74,7 +74,7 @@ Does not return anything, raises an error. -`CVaRMeasurement.compute_cvar(energies, probabilities)` +`CVaRMeasurement.compute_cvar(energies, probabilities)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR. Note that the sampling probabilities serve as an alternative to knowing the counts of each observation and that the input energies are assumed to be sorted in increasing order. @@ -103,7 +103,7 @@ the sampled quantum state described by the inputs (energies, probabilities). For -`CVaRMeasurement.eval(front=None)` +`CVaRMeasurement.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the CVaR as H\_j + 1/α\*(sum\_i\ -`CVaRMeasurement.eval_variance(front=None)` +`CVaRMeasurement.eval_variance(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Given the energies of each sampled measurement outcome (H\_i) as well as the sampling probability of each measurement outcome (p\_i, we can compute the variance of the CVaR estimator as H\_j^2 + 1/α \* (sum\_i\], where H is the diagonal observable and bi corresponds to measurement outcome i. Given this, E\[X^2] = E\[\^2] @@ -149,7 +149,7 @@ and the sampled quantum state described by the inputs (energies, probabilities). -`CVaRMeasurement.get_outcome_energies_probabilities(front=None)` +`CVaRMeasurement.get_outcome_energies_probabilities(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") In order to compute the CVaR of an observable expectation, we require the energies of each sampled measurement outcome as well as the sampling probability of each measurement outcome. Note that the counts for each measurement outcome will also suffice (and this is often how the CVaR is presented). @@ -175,7 +175,7 @@ unique measurement outcome computed against the diagonal observable stored in se -`CVaRMeasurement.mul(scalar)` +`CVaRMeasurement.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -195,7 +195,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)` +`CVaRMeasurement.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -213,7 +213,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`CVaRMeasurement.tensor(other)` +`CVaRMeasurement.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -237,7 +237,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CVaRMeasurement.to_circuit_op()` +`CVaRMeasurement.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -245,7 +245,7 @@ Not defined. -`CVaRMeasurement.to_density_matrix(massive=False)` +`CVaRMeasurement.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -253,7 +253,7 @@ Not defined. -`CVaRMeasurement.to_matrix(massive=False)` +`CVaRMeasurement.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -261,7 +261,7 @@ Not defined. -`CVaRMeasurement.to_matrix_op(massive=False)` +`CVaRMeasurement.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Not defined. @@ -269,7 +269,7 @@ Not defined. -`CVaRMeasurement.traverse(convert_fn, coeff=None)` +`CVaRMeasurement.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CircuitStateFn.md b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CircuitStateFn.md index a2f2dc959c5..37207aa05e6 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CircuitStateFn.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.CircuitStateFn.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.state_fns.CircuitStateFn --- -# CircuitStateFn[¶](#circuitstatefn "Permalink to this headline") +# CircuitStateFn -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by the action of -`CircuitStateFn.add(other)` +`CircuitStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`CircuitStateFn.adjoint()` +`CircuitStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`CircuitStateFn.assign_parameters(param_dict)` +`CircuitStateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -89,7 +89,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`CircuitStateFn.compose(other, permutation=None, front=False)` +`CircuitStateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -115,7 +115,7 @@ An Operator equivalent to the function composition of self and other. -`CircuitStateFn.eval(front=None)` +`CircuitStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -137,7 +137,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`static CircuitStateFn.from_dict(density_dict)` +`static CircuitStateFn.from_dict(density_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a dict mapping strings to probability densities. @@ -157,7 +157,7 @@ The CircuitStateFn created from the dict. -`static CircuitStateFn.from_vector(statevector)` +`static CircuitStateFn.from_vector(statevector)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Construct the CircuitStateFn from a vector representing the statevector. @@ -177,7 +177,7 @@ The CircuitStateFn created from the vector. -`CircuitStateFn.permute(permutation)` +`CircuitStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Permute the qubits of the circuit. @@ -197,7 +197,7 @@ A new CircuitStateFn containing the permuted circuit. -`CircuitStateFn.primitive_strings()` +`CircuitStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -213,7 +213,7 @@ A set of strings describing the primitives contained within the Operator. -`CircuitStateFn.reduce()` +`CircuitStateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -229,7 +229,7 @@ The reduced `OperatorBase`. -`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` +`CircuitStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -241,7 +241,7 @@ Sample the state function as a normalized probability distribution. Returns dict -`CircuitStateFn.tensor(other)` +`CircuitStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like: @@ -265,7 +265,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`CircuitStateFn.to_circuit(meas=False)` +`CircuitStateFn.to_circuit(meas=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return QuantumCircuit representing StateFn @@ -277,7 +277,7 @@ Return QuantumCircuit representing StateFn -`CircuitStateFn.to_circuit_op()` +`CircuitStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -289,7 +289,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`CircuitStateFn.to_density_matrix(massive=False)` +`CircuitStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -301,7 +301,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`CircuitStateFn.to_instruction()` +`CircuitStateFn.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return Instruction corresponding to primitive. @@ -309,7 +309,7 @@ Return Instruction corresponding to primitive. -`CircuitStateFn.to_matrix(massive=False)` +`CircuitStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.DictStateFn.md b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.DictStateFn.md index 60e06290357..c7d0ae099bc 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.DictStateFn.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.DictStateFn.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.state_fns.DictStateFn --- -# DictStateFn[¶](#dictstatefn "Permalink to this headline") +# DictStateFn -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -33,7 +33,7 @@ A class for state functions and measurements which are defined by a lookup table -`DictStateFn.add(other)` +`DictStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -53,7 +53,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`DictStateFn.adjoint()` +`DictStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -69,7 +69,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`DictStateFn.eval(front=None)` +`DictStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -91,7 +91,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`DictStateFn.permute(permutation)` +`DictStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Permute the qubits of the state function. @@ -111,7 +111,7 @@ A new StateFn containing the permuted primitive. -`DictStateFn.primitive_strings()` +`DictStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -127,7 +127,7 @@ A set of strings describing the primitives contained within the Operator. -`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` +`DictStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -149,7 +149,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`DictStateFn.tensor(other)` +`DictStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -173,7 +173,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`DictStateFn.to_circuit_op()` +`DictStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -185,7 +185,7 @@ Convert this state function to a `CircuitStateFn`. -`DictStateFn.to_density_matrix(massive=False)` +`DictStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -209,7 +209,7 @@ The NumPy array representing the density matrix of the State function. -`DictStateFn.to_matrix(massive=False)` +`DictStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -225,7 +225,7 @@ The NumPy `ndarray` equivalent to this Operator. -`DictStateFn.to_spmatrix()` +`DictStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Same as to\_matrix, but returns csr sparse matrix. @@ -245,7 +245,7 @@ CSR sparse matrix representation of the State function. -`DictStateFn.to_spmatrix_op()` +`DictStateFn.to_spmatrix_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Convert this state function to a `SparseVectorStateFn`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.OperatorStateFn.md b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.OperatorStateFn.md index 965d6ba0ecf..3b9d59486b8 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.OperatorStateFn.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.OperatorStateFn.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.state_fns.OperatorStateFn --- -# OperatorStateFn[¶](#operatorstatefn "Permalink to this headline") +# OperatorStateFn -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined by a density Oper -`OperatorStateFn.add(other)` +`OperatorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`OperatorStateFn.adjoint()` +`OperatorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`OperatorStateFn.eval(front=None)` +`OperatorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`OperatorStateFn.permute(permutation)` +`OperatorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`OperatorStateFn.primitive_strings()` +`OperatorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` +`OperatorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -140,7 +140,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`OperatorStateFn.tensor(other)` +`OperatorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -164,7 +164,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`OperatorStateFn.to_circuit_op()` +`OperatorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because this is undefined. TODO maybe call to\_pauli\_op and diagonalize here, but that could be very inefficient, e.g. splitting one Stabilizer measurement into hundreds of 1 qubit Paulis. @@ -172,7 +172,7 @@ Return `StateFnCircuit` corresponding to this StateFn. Ignore for now because th -`OperatorStateFn.to_density_matrix(massive=False)` +`OperatorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return numpy matrix of density operator, warn if more than 16 qubits to force the user to set massive=True if they want such a large matrix. Generally big methods like this should require the use of a converter, but in this case a convenience method for quick hacking and access to classical tools is appropriate. @@ -184,7 +184,7 @@ Return numpy matrix of density operator, warn if more than 16 qubits to force th -`OperatorStateFn.to_matrix(massive=False)` +`OperatorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Note: this does not return a density matrix, it returns a classical matrix containing the quantum or classical vector representing the evaluation of the state function on each binary basis state. Do not assume this is is a normalized quantum or classical probability vector. If we allowed this to return a density matrix, then we would need to change the definition of composition to be \~Op @ StateFn @ Op for those cases, whereas by this methodology we can ensure that composition always means Op @ StateFn. @@ -210,7 +210,7 @@ np.ndarray -`OperatorStateFn.to_matrix_op(massive=False)` +`OperatorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Return a MatrixOp for this operator. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.SparseVectorStateFn.md b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.SparseVectorStateFn.md index 91d94a994aa..b713aea4165 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.SparseVectorStateFn.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.SparseVectorStateFn.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn --- -# SparseVectorStateFn[¶](#sparsevectorstatefn "Permalink to this headline") +# SparseVectorStateFn -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -35,7 +35,7 @@ This class uses `scipy.sparse.spmatrix` for the internal representation. -`SparseVectorStateFn.add(other)` +`SparseVectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -55,7 +55,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`SparseVectorStateFn.adjoint()` +`SparseVectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -71,7 +71,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`SparseVectorStateFn.equals(other)` +`SparseVectorStateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -91,7 +91,7 @@ A bool equal to the equality of self and other. -`SparseVectorStateFn.eval(front=None)` +`SparseVectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -113,7 +113,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`SparseVectorStateFn.primitive_strings()` +`SparseVectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -129,7 +129,7 @@ A set of strings describing the primitives contained within the Operator. -`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` +`SparseVectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -151,7 +151,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`SparseVectorStateFn.to_circuit_op()` +`SparseVectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `CircuitStateFn`. @@ -163,7 +163,7 @@ Convert this state function to a `CircuitStateFn`. -`SparseVectorStateFn.to_dict_fn()` +`SparseVectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Convert this state function to a `DictStateFn`. @@ -179,7 +179,7 @@ A new DictStateFn equivalent to `self`. -`SparseVectorStateFn.to_matrix(massive=False)` +`SparseVectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -195,7 +195,7 @@ The NumPy `ndarray` equivalent to this Operator. -`SparseVectorStateFn.to_matrix_op(massive=False)` +`SparseVectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -215,7 +215,7 @@ A VectorStateFn equivalent to self. -`SparseVectorStateFn.to_spmatrix()` +`SparseVectorStateFn.to_spmatrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Return SciPy sparse matrix representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.StateFn.md b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.StateFn.md index 70aa019894a..70a5da7a4b5 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.StateFn.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.StateFn.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.state_fns.StateFn --- -# StateFn[¶](#statefn "Permalink to this headline") +# StateFn -`StateFn(primitive=None, coeff=1.0, is_measurement=False)` +`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: [`qiskit.opflow.operator_base.OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.operator_base.OperatorBase") @@ -34,7 +34,7 @@ NOTE: State functions here are not restricted to wave functions, as there is no -`StateFn.add(other)` +`StateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -54,7 +54,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`StateFn.adjoint()` +`StateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -70,7 +70,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`StateFn.assign_parameters(param_dict)` +`StateFn.assign_parameters(param_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. @@ -90,7 +90,7 @@ The `OperatorBase` with the `Parameters` in self replaced by the values or `Para -`StateFn.compose(other, permutation=None, front=False)` +`StateFn.compose(other, permutation=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Composition (Linear algebra-style: A\@B(x) = A(B(x))) is not well defined for states in the binary function model, but is well defined for measurements. @@ -116,7 +116,7 @@ An Operator equivalent to the function composition of self and other. -`StateFn.equals(other)` +`StateFn.equals(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. @@ -136,7 +136,7 @@ A bool equal to the equality of self and other. -`StateFn.eval(front=None)` +`StateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -158,7 +158,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`StateFn.mul(scalar)` +`StateFn.mul(scalar)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). @@ -178,7 +178,7 @@ An `OperatorBase` equivalent to product of self and scalar. -`StateFn.permute(permutation)` +`StateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Permute the qubits of the state function. @@ -198,7 +198,7 @@ A new StateFn containing the permuted primitive. -`StateFn.power(exponent)` +`StateFn.power(exponent)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Compose with Self Multiple Times, undefined for StateFns. @@ -218,7 +218,7 @@ Compose with Self Multiple Times, undefined for StateFns. -`StateFn.primitive_strings()` +`StateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -234,7 +234,7 @@ A set of strings describing the primitives contained within the Operator. -`StateFn.reduce()` +`StateFn.reduce()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. @@ -250,7 +250,7 @@ The reduced `OperatorBase`. -`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)` +`StateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -272,7 +272,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`StateFn.tensor(other)` +`StateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -296,7 +296,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`StateFn.tensorpower(other)` +`StateFn.tensorpower(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return tensor product with self multiple times, overloaded by `^`. @@ -316,7 +316,7 @@ An `OperatorBase` equivalent to the tensorpower of self by other. -`StateFn.to_circuit_op()` +`StateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Returns a `CircuitOp` equivalent to this Operator. @@ -328,7 +328,7 @@ Returns a `CircuitOp` equivalent to this Operator. -`StateFn.to_density_matrix(massive=False)` +`StateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -352,7 +352,7 @@ The NumPy array representing the density matrix of the State function. -`StateFn.to_matrix(massive=False)` +`StateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -368,7 +368,7 @@ The NumPy `ndarray` equivalent to this Operator. -`StateFn.to_matrix_op(massive=False)` +`StateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. @@ -388,7 +388,7 @@ A VectorStateFn equivalent to self. -`StateFn.traverse(convert_fn, coeff=None)` +`StateFn.traverse(convert_fn, coeff=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/state_fn.py "view source code") Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). Otherwise do nothing. Used by converters. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.VectorStateFn.md b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.VectorStateFn.md index 702b6eb2bb2..4f7ff608921 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.VectorStateFn.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.VectorStateFn.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.opflow.state_fns.VectorStateFn --- -# VectorStateFn[¶](#vectorstatefn "Permalink to this headline") +# VectorStateFn -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: [`qiskit.opflow.state_fns.state_fn.StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.state_fn.StateFn") @@ -28,7 +28,7 @@ A class for state functions and measurements which are defined in vector represe -`VectorStateFn.add(other)` +`VectorStateFn.add(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return Operator addition of self and other, overloaded by `+`. @@ -48,7 +48,7 @@ An `OperatorBase` equivalent to the sum of self and other. -`VectorStateFn.adjoint()` +`VectorStateFn.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. @@ -64,7 +64,7 @@ An `OperatorBase` equivalent to the adjoint of self. -`VectorStateFn.eval(front=None)` +`VectorStateFn.eval(front=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). @@ -86,7 +86,7 @@ The output of the Operator’s evaluation function. If self is a `StateFn`, the -`VectorStateFn.permute(permutation)` +`VectorStateFn.permute(permutation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Permute the qubits of the state function. @@ -106,7 +106,7 @@ A new StateFn containing the permuted primitive. -`VectorStateFn.primitive_strings()` +`VectorStateFn.primitive_strings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. @@ -122,7 +122,7 @@ A set of strings describing the primitives contained within the Operator. -`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)` +`VectorStateFn.sample(shots=1024, massive=False, reverse_endianness=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Sample the state function as a normalized probability distribution. Returns dict of bitstrings in order of probability, with values being probability. @@ -144,7 +144,7 @@ A dict containing pairs sampled strings from the State function and sampling fre -`VectorStateFn.tensor(other)` +`VectorStateFn.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, Plus.tensor(Zero) produces a |+⟩ on qubit 0 and a |0⟩ on qubit 1, or |+⟩⨂|0⟩, but would produce a QuantumCircuit like @@ -168,7 +168,7 @@ An `OperatorBase` equivalent to the tensor product of self and other. -`VectorStateFn.to_circuit_op()` +`VectorStateFn.to_circuit_op()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return `StateFnCircuit` corresponding to this StateFn. @@ -180,7 +180,7 @@ Return `StateFnCircuit` corresponding to this StateFn. -`VectorStateFn.to_density_matrix(massive=False)` +`VectorStateFn.to_density_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return matrix representing product of StateFn evaluated on pairs of basis states. Overridden by child classes. @@ -204,7 +204,7 @@ The NumPy array representing the density matrix of the State function. -`VectorStateFn.to_dict_fn()` +`VectorStateFn.to_dict_fn()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Creates the equivalent state function of type DictStateFn. @@ -220,7 +220,7 @@ A new DictStateFn equivalent to `self`. -`VectorStateFn.to_matrix(massive=False)` +`VectorStateFn.to_matrix(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. @@ -236,7 +236,7 @@ The NumPy `ndarray` equivalent to this Operator. -`VectorStateFn.to_matrix_op(massive=False)` +`VectorStateFn.to_matrix_op(massive=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Return a `VectorStateFn` for this `StateFn`. diff --git a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.md b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.md index 4a5323b85ba..2ffffc20990 100644 --- a/docs/api/qiskit/0.41/qiskit.opflow.state_fns.md +++ b/docs/api/qiskit/0.41/qiskit.opflow.state_fns.md @@ -1,8 +1,8 @@ -# qiskit.opflow\.state\_fns[¶](#module-qiskit.opflow.state_fns "Permalink to this headline") +# qiskit.opflow\.state\_fns -## State Functions ([`qiskit.opflow.state_fns`](#module-qiskit.opflow.state_fns "qiskit.opflow.state_fns"))[¶](#state-functions-qiskit-opflow-state-fns "Permalink to this headline") +## State Functions ([`qiskit.opflow.state_fns`](#module-qiskit.opflow.state_fns "qiskit.opflow.state_fns")) State functions are defined to be complex functions over a single binary string (as compared to an operator, which is defined as a function over two binary strings, or a function taking a binary function to another binary function). This function may be called by the eval() method. @@ -16,7 +16,7 @@ Measurements are defined to be functionals over StateFns, taking them to real va State functions here are not restricted to wave functions, as there is no requirement of normalization. -### State Functions[¶](#state-functions "Permalink to this headline") +### State Functions | | | | -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/api/qiskit/0.41/qiskit.primitives.BackendEstimator.md b/docs/api/qiskit/0.41/qiskit.primitives.BackendEstimator.md index 183ba5020aa..2880480a49a 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.BackendEstimator.md +++ b/docs/api/qiskit/0.41/qiskit.primitives.BackendEstimator.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.primitives.BackendEstimator --- -# BackendEstimator[¶](#backendestimator "Permalink to this headline") +# BackendEstimator -`BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)` +`BackendEstimator(backend, options=None, abelian_grouping=True, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_estimator.py "view source code") Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") @@ -96,7 +96,7 @@ Set options values for the estimator. -`BackendEstimator.set_transpile_options(**fields)` +`BackendEstimator.set_transpile_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_estimator.py "view source code") Set the transpiler options for transpiler. :param \*\*fields: The fields to update the options diff --git a/docs/api/qiskit/0.41/qiskit.primitives.BackendSampler.md b/docs/api/qiskit/0.41/qiskit.primitives.BackendSampler.md index 71fbe7d13fa..d7fc0f78865 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.BackendSampler.md +++ b/docs/api/qiskit/0.41/qiskit.primitives.BackendSampler.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.primitives.BackendSampler --- -# BackendSampler[¶](#backendsampler "Permalink to this headline") +# BackendSampler -`BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)` +`BackendSampler(backend, options=None, bound_pass_manager=None, skip_transpilation=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_sampler.py "view source code") Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") @@ -79,7 +79,7 @@ Set options values for the estimator. -`BackendSampler.set_transpile_options(**fields)` +`BackendSampler.set_transpile_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/backend_sampler.py "view source code") Set the transpiler options for transpiler. :param \*\*fields: The fields to update the options. diff --git a/docs/api/qiskit/0.41/qiskit.primitives.BaseEstimator.md b/docs/api/qiskit/0.41/qiskit.primitives.BaseEstimator.md index 8cb18cb0755..01c32fe8abb 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.BaseEstimator.md +++ b/docs/api/qiskit/0.41/qiskit.primitives.BaseEstimator.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.primitives.BaseEstimator --- -# BaseEstimator[¶](#baseestimator "Permalink to this headline") +# BaseEstimator -`BaseEstimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` +`BaseEstimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") Bases: `qiskit.primitives.base.base_primitive.BasePrimitive` @@ -37,7 +37,7 @@ Creating an instance of an Estimator, or using one in a `with` context opens a s -`BaseEstimator.close()` +`BaseEstimator.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") Close the session and free resources @@ -45,7 +45,7 @@ Close the session and free resources -`BaseEstimator.run(circuits, observables, parameter_values=None, **run_options)` +`BaseEstimator.run(circuits, observables, parameter_values=None, **run_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_estimator.py "view source code") Run the job of the estimation of expectation value(s). diff --git a/docs/api/qiskit/0.41/qiskit.primitives.BaseSampler.md b/docs/api/qiskit/0.41/qiskit.primitives.BaseSampler.md index ea617983327..37519392c28 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.BaseSampler.md +++ b/docs/api/qiskit/0.41/qiskit.primitives.BaseSampler.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.primitives.BaseSampler --- -# BaseSampler[¶](#basesampler "Permalink to this headline") +# BaseSampler -`BaseSampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` +`BaseSampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") Bases: `qiskit.primitives.base.base_primitive.BasePrimitive` @@ -34,7 +34,7 @@ Base class of Sampler that calculates quasi-probabilities of bitstrings from qua -`BaseSampler.close()` +`BaseSampler.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") Close the session and free resources @@ -42,7 +42,7 @@ Close the session and free resources -`BaseSampler.run(circuits, parameter_values=None, **run_options)` +`BaseSampler.run(circuits, parameter_values=None, **run_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/base_sampler.py "view source code") Run the job of the sampling of bitstrings. diff --git a/docs/api/qiskit/0.41/qiskit.primitives.Estimator.md b/docs/api/qiskit/0.41/qiskit.primitives.Estimator.md index c46bf6555d0..9aaafb990d9 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.Estimator.md +++ b/docs/api/qiskit/0.41/qiskit.primitives.Estimator.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.primitives.Estimator --- -# Estimator[¶](#estimator "Permalink to this headline") +# Estimator -`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` +`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/estimator.py "view source code") Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") @@ -38,7 +38,7 @@ Reference implementation of [`BaseEstimator`](qiskit.primitives.BaseEstimator "q -`Estimator.close()` +`Estimator.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/estimator.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.41/qiskit.primitives.EstimatorResult.md b/docs/api/qiskit/0.41/qiskit.primitives.EstimatorResult.md index 6919f4ca31d..e0929a1e689 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.EstimatorResult.md +++ b/docs/api/qiskit/0.41/qiskit.primitives.EstimatorResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.primitives.EstimatorResult --- -# EstimatorResult[¶](#estimatorresult "Permalink to this headline") +# EstimatorResult -`EstimatorResult(values, metadata)` +`EstimatorResult(values, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/estimator_result.py "view source code") Bases: `qiskit.primitives.base.base_result.BasePrimitiveResult` diff --git a/docs/api/qiskit/0.41/qiskit.primitives.Sampler.md b/docs/api/qiskit/0.41/qiskit.primitives.Sampler.md index 5c58bacce8c..f14c48ceca3 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.Sampler.md +++ b/docs/api/qiskit/0.41/qiskit.primitives.Sampler.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.primitives.Sampler --- -# Sampler[¶](#sampler "Permalink to this headline") +# Sampler -`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` +`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/sampler.py "view source code") Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") @@ -39,7 +39,7 @@ Sampler class. -`Sampler.close()` +`Sampler.close()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.41/qiskit.primitives.SamplerResult.md b/docs/api/qiskit/0.41/qiskit.primitives.SamplerResult.md index 88f6b9b8103..d07f2dc6672 100644 --- a/docs/api/qiskit/0.41/qiskit.primitives.SamplerResult.md +++ b/docs/api/qiskit/0.41/qiskit.primitives.SamplerResult.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.primitives.SamplerResult --- -# SamplerResult[¶](#samplerresult "Permalink to this headline") +# SamplerResult -`SamplerResult(quasi_dists, metadata)` +`SamplerResult(quasi_dists, metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/primitives/base/sampler_result.py "view source code") Bases: `qiskit.primitives.base.base_result.BasePrimitiveResult` diff --git a/docs/api/qiskit/0.41/qiskit.providers.Backend.md b/docs/api/qiskit/0.41/qiskit.providers.Backend.md index b322cbab850..18e60ad5e81 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.41/qiskit.providers.Backend.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.Backend --- -# Backend[¶](#backend "Permalink to this headline") +# Backend -`Backend` +`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.41/qiskit.providers.BackendPropertyError.md index 0b93049a72c..83a8dc76c25 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.BackendPropertyError.md @@ -6,11 +6,11 @@ python_api_type: exception python_api_name: qiskit.providers.BackendPropertyError --- -# qiskit.providers.BackendPropertyError[¶](#qiskit-providers-backendpropertyerror "Permalink to this headline") +# qiskit.providers.BackendPropertyError -`BackendPropertyError(*message)` +`BackendPropertyError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend property. diff --git a/docs/api/qiskit/0.41/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.41/qiskit.providers.BackendV1.md index 06ffc39f759..9563703aefa 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.41/qiskit.providers.BackendV1.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.BackendV1 --- -# BackendV1[¶](#backendv1 "Permalink to this headline") +# BackendV1 -`BackendV1(configuration, provider=None, **fields)` +`BackendV1(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` @@ -60,7 +60,7 @@ default values set -`BackendV1.configuration()` +`BackendV1.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend configuration. @@ -76,7 +76,7 @@ the configuration for the backend. -`BackendV1.name()` +`BackendV1.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend name. @@ -92,7 +92,7 @@ str -`BackendV1.properties()` +`BackendV1.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend properties. @@ -108,7 +108,7 @@ the configuration for the backend. If the backend does not support properties, i -`BackendV1.provider()` +`BackendV1.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend Provider. @@ -124,7 +124,7 @@ the Provider responsible for the backend. -`abstract BackendV1.run(run_input, **options)` +`abstract BackendV1.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Run on the backend. @@ -147,7 +147,7 @@ The job object for the run -`BackendV1.set_options(**fields)` +`BackendV1.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Set the options fields for the backend @@ -165,7 +165,7 @@ This method is used to update the options of a backend. If you need to change an -`BackendV1.status()` +`BackendV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.41/qiskit.providers.BackendV2.md b/docs/api/qiskit/0.41/qiskit.providers.BackendV2.md index 56fabb26bf9..ff1ae490b38 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.BackendV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.BackendV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.BackendV2 --- -# BackendV2[¶](#backendv2 "Permalink to this headline") +# BackendV2 -`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)` +`BackendV2(provider=None, name=None, description=None, online_date=None, backend_version=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Bases: [`qiskit.providers.backend.Backend`](qiskit.providers.Backend "qiskit.providers.backend.Backend"), `abc.ABC` @@ -45,7 +45,7 @@ Initialize a BackendV2 based backend -`BackendV2.acquire_channel(qubit)` +`BackendV2.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the acquisition channel for the given qubit. @@ -67,7 +67,7 @@ The Qubit measurement acquisition line. -`BackendV2.control_channel(qubits)` +`BackendV2.control_channel(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the secondary drive channel for the given qubit @@ -95,7 +95,7 @@ List\[[ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channe -`BackendV2.drive_channel(qubit)` +`BackendV2.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the drive channel for the given qubit. @@ -117,7 +117,7 @@ The Qubit drive channel -`BackendV2.measure_channel(qubit)` +`BackendV2.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return the measure stimulus channel for the given qubit. @@ -139,7 +139,7 @@ The Qubit measurement stimulus line -`BackendV2.qubit_properties(qubit)` +`BackendV2.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Return QubitProperties for a given qubit. @@ -165,7 +165,7 @@ qubit\_properties -`abstract BackendV2.run(run_input, **options)` +`abstract BackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Run on the backend. @@ -188,7 +188,7 @@ The job object for the run -`BackendV2.set_options(**fields)` +`BackendV2.set_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Set the options fields for the backend diff --git a/docs/api/qiskit/0.41/qiskit.providers.BackendV2Converter.md b/docs/api/qiskit/0.41/qiskit.providers.BackendV2Converter.md index bf6d5a23058..5d039f69646 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.BackendV2Converter.md +++ b/docs/api/qiskit/0.41/qiskit.providers.BackendV2Converter.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.BackendV2Converter --- -# BackendV2Converter[¶](#backendv2converter "Permalink to this headline") +# BackendV2Converter -`BackendV2Converter(backend, name_mapping=None, add_delay=False)` +`BackendV2Converter(backend, name_mapping=None, add_delay=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -32,7 +32,7 @@ Initialize a BackendV2 converter instance based on a BackendV1 instance. -`BackendV2Converter.acquire_channel(qubit)` +`BackendV2Converter.acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Return the acquisition channel for the given qubit. @@ -54,7 +54,7 @@ The Qubit measurement acquisition line. -`BackendV2Converter.control_channel(qubits)` +`BackendV2Converter.control_channel(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Return the secondary drive channel for the given qubit @@ -82,7 +82,7 @@ List\[[ControlChannel](qiskit.pulse.channels.ControlChannel "qiskit.pulse.channe -`BackendV2Converter.drive_channel(qubit)` +`BackendV2Converter.drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Return the drive channel for the given qubit. @@ -104,7 +104,7 @@ The Qubit drive channel -`BackendV2Converter.measure_channel(qubit)` +`BackendV2Converter.measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Return the measure stimulus channel for the given qubit. @@ -152,7 +152,7 @@ qubit\_properties -`BackendV2Converter.run(run_input, **options)` +`BackendV2Converter.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.Job.md b/docs/api/qiskit/0.41/qiskit.providers.Job.md index fba3ce588e1..be4d4d20fee 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.41/qiskit.providers.Job.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.Job --- -# Job[¶](#job "Permalink to this headline") +# Job -`Job` +`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.providers.JobError.md b/docs/api/qiskit/0.41/qiskit.providers.JobError.md index 11298352d1b..9f780d95c92 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.JobError.md @@ -6,11 +6,11 @@ python_api_type: exception python_api_name: qiskit.providers.JobError --- -# qiskit.providers.JobError[¶](#qiskit-providers-joberror "Permalink to this headline") +# qiskit.providers.JobError -`JobError(*message)` +`JobError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") Base class for errors raised by Jobs. diff --git a/docs/api/qiskit/0.41/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.41/qiskit.providers.JobStatus.md index 66884d9f257..a4b6663259e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.41/qiskit.providers.JobStatus.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.JobStatus --- -# JobStatus[¶](#jobstatus "Permalink to this headline") +# JobStatus -`JobStatus(value)` +`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/jobstatus.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.41/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.41/qiskit.providers.JobTimeoutError.md index 4bf5e00cc14..904562b003d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.JobTimeoutError.md @@ -6,11 +6,11 @@ python_api_type: exception python_api_name: qiskit.providers.JobTimeoutError --- -# qiskit.providers.JobTimeoutError[¶](#qiskit-providers-jobtimeouterror "Permalink to this headline") +# qiskit.providers.JobTimeoutError -`JobTimeoutError(*message)` +`JobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") Base class for timeout errors raised by jobs. diff --git a/docs/api/qiskit/0.41/qiskit.providers.JobV1.md b/docs/api/qiskit/0.41/qiskit.providers.JobV1.md index 06a11ef29c0..9d3cffe0b57 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.41/qiskit.providers.JobV1.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.JobV1 --- -# JobV1[¶](#jobv1 "Permalink to this headline") +# JobV1 -`JobV1(backend, job_id, **kwargs)` +`JobV1(backend, job_id, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Bases: [`qiskit.providers.job.Job`](qiskit.providers.Job "qiskit.providers.job.Job"), `abc.ABC` @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`JobV1.backend()` +`JobV1.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return the backend where this job was executed. @@ -44,7 +44,7 @@ Return the backend where this job was executed. -`JobV1.cancel()` +`JobV1.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Attempt to cancel the job. @@ -52,7 +52,7 @@ Attempt to cancel the job. -`JobV1.cancelled()` +`JobV1.cancelled()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return whether the job has been cancelled. @@ -64,7 +64,7 @@ Return whether the job has been cancelled. -`JobV1.done()` +`JobV1.done()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return whether the job has successfully run. @@ -76,7 +76,7 @@ Return whether the job has successfully run. -`JobV1.in_final_state()` +`JobV1.in_final_state()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return whether the job is in a final job state such as `DONE` or `ERROR`. @@ -88,7 +88,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`JobV1.job_id()` +`JobV1.job_id()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return a unique id identifying the job. @@ -100,7 +100,7 @@ Return a unique id identifying the job. -`abstract JobV1.result()` +`abstract JobV1.result()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return the results of the job. @@ -108,7 +108,7 @@ Return the results of the job. -`JobV1.running()` +`JobV1.running()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return whether the job is actively running. @@ -120,7 +120,7 @@ Return whether the job is actively running. -`abstract JobV1.status()` +`abstract JobV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Return the status of the job, among the values of `JobStatus`. @@ -128,7 +128,7 @@ Return the status of the job, among the values of `JobStatus`. -`abstract JobV1.submit()` +`abstract JobV1.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Submit the job to the backend for execution. @@ -136,7 +136,7 @@ Submit the job to the backend for execution. -`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)` +`JobV1.wait_for_final_state(timeout=None, wait=5, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.41/qiskit.providers.Options.md b/docs/api/qiskit/0.41/qiskit.providers.Options.md index 953e8e4328e..40dd58c566b 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.41/qiskit.providers.Options.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.Options --- -# Options[¶](#options "Permalink to this headline") +# Options -`Options(**kwargs)` +`Options(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is the abstract class that all backend options are based on. The prop -`Options.get(field, default=None)` +`Options.get(field, default=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") Get an option value for a given key. @@ -32,7 +32,7 @@ Get an option value for a given key. -`Options.set_validator(field, validator_value)` +`Options.set_validator(field, validator_value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") Set an optional validator for a field in the options @@ -59,7 +59,7 @@ In this case whenever the `"shots"` option is updated by the user it will enforc -`Options.update_options(**fields)` +`Options.update_options(**fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/options.py "view source code") Update options with kwargs diff --git a/docs/api/qiskit/0.41/qiskit.providers.Provider.md b/docs/api/qiskit/0.41/qiskit.providers.Provider.md index 5d0a523aed3..25a66ac2c3f 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.41/qiskit.providers.Provider.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.Provider --- -# Provider[¶](#provider "Permalink to this headline") +# Provider -`Provider` +`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.41/qiskit.providers.ProviderV1.md index d66bc6c66e2..4cb8cf018b1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ProviderV1.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.ProviderV1 --- -# ProviderV1[¶](#providerv1 "Permalink to this headline") +# ProviderV1 -`ProviderV1` +`ProviderV1`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") Bases: [`qiskit.providers.provider.Provider`](qiskit.providers.Provider "qiskit.providers.provider.Provider"), `abc.ABC` @@ -22,7 +22,7 @@ Base class for a Backend Provider. -`abstract ProviderV1.backends(name=None, **kwargs)` +`abstract ProviderV1.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`ProviderV1.get_backend(name=None, **kwargs)` +`ProviderV1.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.41/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.41/qiskit.providers.QiskitBackendNotFoundError.md index 87f1d470266..706d8d392e2 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.QiskitBackendNotFoundError.md @@ -6,11 +6,11 @@ python_api_type: exception python_api_name: qiskit.providers.QiskitBackendNotFoundError --- -# qiskit.providers.QiskitBackendNotFoundError[¶](#qiskit-providers-qiskitbackendnotfounderror "Permalink to this headline") +# qiskit.providers.QiskitBackendNotFoundError -`QiskitBackendNotFoundError(*message)` +`QiskitBackendNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/exceptions.py "view source code") Base class for errors raised while looking for a backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.QubitProperties.md b/docs/api/qiskit/0.41/qiskit.providers.QubitProperties.md index 774c9c90723..4542d93aadb 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.QubitProperties.md +++ b/docs/api/qiskit/0.41/qiskit.providers.QubitProperties.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.QubitProperties --- -# QubitProperties[¶](#qubitproperties "Permalink to this headline") +# QubitProperties -`QubitProperties(t1=None, t2=None, frequency=None)` +`QubitProperties(t1=None, t2=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerError.md b/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerError.md index 0f8e76dabaa..56e1413bf32 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerError.md @@ -6,11 +6,11 @@ python_api_type: exception python_api_name: qiskit.providers.basicaer.BasicAerError --- -# qiskit.providers.basicaer.BasicAerError[¶](#qiskit-providers-basicaer-basicaererror "Permalink to this headline") +# qiskit.providers.basicaer.BasicAerError -`BasicAerError(*message)` +`BasicAerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/exceptions.py "view source code") Base class for errors raised by Basic Aer. diff --git a/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerJob.md b/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerJob.md index 1a6febd1aba..a39510f0233 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerJob.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.basicaer.BasicAerJob --- -# BasicAerJob[¶](#basicaerjob "Permalink to this headline") +# BasicAerJob -`BasicAerJob(backend, job_id, result)` +`BasicAerJob(backend, job_id, result)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -30,7 +30,7 @@ Initializes the asynchronous job. -`BasicAerJob.backend()` +`BasicAerJob.backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Return the instance of the backend used for this job. @@ -94,7 +94,7 @@ Return a unique id identifying the job. -`BasicAerJob.result(timeout=None)` +`BasicAerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Get job result . @@ -122,7 +122,7 @@ Return whether the job is actively running. -`BasicAerJob.status()` +`BasicAerJob.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -138,7 +138,7 @@ The current JobStatus -`BasicAerJob.submit()` +`BasicAerJob.submit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerProvider.md b/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerProvider.md index 1b04ca63e83..964d67a213e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.41/qiskit.providers.basicaer.BasicAerProvider.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.basicaer.BasicAerProvider --- -# BasicAerProvider[¶](#basicaerprovider "Permalink to this headline") +# BasicAerProvider -`BasicAerProvider` +`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -22,7 +22,7 @@ Provider for Basic Aer backends. -`BasicAerProvider.backends(name=None, filters=None, **kwargs)` +`BasicAerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`BasicAerProvider.get_backend(name=None, **kwargs)` +`BasicAerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/basicaerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.41/qiskit.providers.basicaer.QasmSimulatorPy.md b/docs/api/qiskit/0.41/qiskit.providers.basicaer.QasmSimulatorPy.md index c679bbb506c..227f85a8a3c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.41/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.basicaer.QasmSimulatorPy --- -# QasmSimulatorPy[¶](#qasmsimulatorpy "Permalink to this headline") +# QasmSimulatorPy -`QasmSimulatorPy(configuration=None, provider=None, **fields)` +`QasmSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`QasmSimulatorPy.run(qobj, **backend_options)` +`QasmSimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run qobj asynchronously. @@ -157,7 +157,7 @@ backend_options = { -`QasmSimulatorPy.run_experiment(experiment)` +`QasmSimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/qasm_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.41/qiskit.providers.basicaer.StatevectorSimulatorPy.md b/docs/api/qiskit/0.41/qiskit.providers.basicaer.StatevectorSimulatorPy.md index 86cb45650e9..7b7d8e00483 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.41/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy --- -# StatevectorSimulatorPy[¶](#statevectorsimulatorpy "Permalink to this headline") +# StatevectorSimulatorPy -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` +`StatevectorSimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/statevector_simulator.py "view source code") Bases: [`qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.qasm_simulator.QasmSimulatorPy") diff --git a/docs/api/qiskit/0.41/qiskit.providers.basicaer.UnitarySimulatorPy.md b/docs/api/qiskit/0.41/qiskit.providers.basicaer.UnitarySimulatorPy.md index 87a491afdac..fb1766f95be 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.41/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy --- -# UnitarySimulatorPy[¶](#unitarysimulatorpy "Permalink to this headline") +# UnitarySimulatorPy -`UnitarySimulatorPy(configuration=None, provider=None, **fields)` +`UnitarySimulatorPy(configuration=None, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -120,7 +120,7 @@ the Provider responsible for the backend. -`UnitarySimulatorPy.run(qobj, **backend_options)` +`UnitarySimulatorPy.run(qobj, **backend_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run qobj asynchronously. @@ -168,7 +168,7 @@ Example:: -`UnitarySimulatorPy.run_experiment(experiment)` +`UnitarySimulatorPy.run_experiment(experiment)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/basicaer/unitary_simulator.py "view source code") Run an experiment (circuit) and return a single experiment result. diff --git a/docs/api/qiskit/0.41/qiskit.providers.convert_to_target.md b/docs/api/qiskit/0.41/qiskit.providers.convert_to_target.md index 1166761774a..c46def02bd9 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.convert_to_target.md +++ b/docs/api/qiskit/0.41/qiskit.providers.convert_to_target.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.providers.convert_to_target --- -# qiskit.providers.convert\_to\_target[¶](#qiskit-providers-convert-to-target "Permalink to this headline") +# qiskit.providers.convert\_to\_target -`convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False)` +`convert_to_target(configuration, properties=None, defaults=None, custom_name_mapping=None, add_delay=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/backend_compat.py "view source code") Uses configuration, properties and pulse defaults to construct and return Target class. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.ConfigurableFakeBackend.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.ConfigurableFakeBackend.md index 94d540d3c91..9bbe2efd197 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.ConfigurableFakeBackend.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.ConfigurableFakeBackend.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.ConfigurableFakeBackend --- -# ConfigurableFakeBackend[¶](#configurablefakebackend "Permalink to this headline") +# ConfigurableFakeBackend -`ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)` +`ConfigurableFakeBackend(name, n_qubits, version=None, coupling_map=None, basis_gates=None, qubit_t1=None, qubit_t2=None, qubit_frequency=None, qubit_readout_error=None, single_qubit_gates=None, dt=None, std=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -56,7 +56,7 @@ the configuration for the backend. -`ConfigurableFakeBackend.defaults()` +`ConfigurableFakeBackend.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Return backend defaults. @@ -80,7 +80,7 @@ str -`ConfigurableFakeBackend.properties()` +`ConfigurableFakeBackend.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/utils/configurable_backend.py "view source code") Return backend properties diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.Fake1Q.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.Fake1Q.md index fab669986ed..8d594a5d8c7 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.Fake1Q.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.Fake1Q.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.Fake1Q --- -# Fake1Q[¶](#fake1q "Permalink to this headline") +# Fake1Q -`Fake1Q` +`Fake1Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -40,7 +40,7 @@ the configuration for the backend. -`Fake1Q.defaults()` +`Fake1Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") defaults == configuration @@ -64,7 +64,7 @@ str -`Fake1Q.properties()` +`Fake1Q.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_1q.py "view source code") properties == configuration diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmaden.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmaden.md index 50a2783754e..97d30fd5936 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmaden.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmaden.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeAlmaden --- -# FakeAlmaden[¶](#fakealmaden "Permalink to this headline") +# FakeAlmaden -`FakeAlmaden` +`FakeAlmaden`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmadenV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmadenV2.md index 227af56f4e5..8c6a1b169dd 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmadenV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAlmadenV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeAlmadenV2 --- -# FakeAlmadenV2[¶](#fakealmadenv2 "Permalink to this headline") +# FakeAlmadenV2 -`FakeAlmadenV2` +`FakeAlmadenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/almaden/fake_almaden.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonk.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonk.md index 04fd942e6bd..d64672ed455 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonk.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonk.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeArmonk --- -# FakeArmonk[¶](#fakearmonk "Permalink to this headline") +# FakeArmonk -`FakeArmonk` +`FakeArmonk`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonkV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonkV2.md index c55b2ff74bf..593a3f6e1e9 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonkV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeArmonkV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeArmonkV2 --- -# FakeArmonkV2[¶](#fakearmonkv2 "Permalink to this headline") +# FakeArmonkV2 -`FakeArmonkV2` +`FakeArmonkV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/armonk/fake_armonk.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthens.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthens.md index 62587f49695..dee5feae2ad 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthens.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthens.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeAthens --- -# FakeAthens[¶](#fakeathens "Permalink to this headline") +# FakeAthens -`FakeAthens` +`FakeAthens`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthensV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthensV2.md index e4a44c45deb..066bc4f5075 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthensV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAthensV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeAthensV2 --- -# FakeAthensV2[¶](#fakeathensv2 "Permalink to this headline") +# FakeAthensV2 -`FakeAthensV2` +`FakeAthensV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/athens/fake_athens.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAuckland.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAuckland.md index c64554f79b5..c97fabc05c1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAuckland.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeAuckland.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeAuckland --- -# FakeAuckland[¶](#fakeauckland "Permalink to this headline") +# FakeAuckland -`FakeAuckland` +`FakeAuckland`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/auckland/fake_auckland.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackend5QV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackend5QV2.md index a5fa0efee47..9ef203b53d3 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackend5QV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackend5QV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeBackend5QV2 --- -# FakeBackend5QV2[¶](#fakebackend5qv2 "Permalink to this headline") +# FakeBackend5QV2 -`FakeBackend5QV2(bidirectional=True)` +`FakeBackend5QV2(bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -157,7 +157,7 @@ qubit\_properties -`FakeBackend5QV2.run(run_input, **options)` +`FakeBackend5QV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackendV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackendV2.md index ede10e42e95..d7eb853cc50 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackendV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBackendV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeBackendV2 --- -# FakeBackendV2[¶](#fakebackendv2 "Permalink to this headline") +# FakeBackendV2 -`FakeBackendV2` +`FakeBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -157,7 +157,7 @@ qubit\_properties -`FakeBackendV2.run(run_input, **options)` +`FakeBackendV2.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_backend_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelem.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelem.md index bd5b8490e84..24b299479a0 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelem.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelem.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeBelem --- -# FakeBelem[¶](#fakebelem "Permalink to this headline") +# FakeBelem -`FakeBelem` +`FakeBelem`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelemV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelemV2.md index 0790e49e8d9..c26723a5361 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelemV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBelemV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeBelemV2 --- -# FakeBelemV2[¶](#fakebelemv2 "Permalink to this headline") +# FakeBelemV2 -`FakeBelemV2` +`FakeBelemV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/belem/fake_belem.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingen.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingen.md index 6671688cc66..22d821f3d25 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingen.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingen.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeBoeblingen --- -# FakeBoeblingen[¶](#fakeboeblingen "Permalink to this headline") +# FakeBoeblingen -`FakeBoeblingen` +`FakeBoeblingen`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingenV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingenV2.md index 1f20d159279..3cf34405dbc 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingenV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBoeblingenV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeBoeblingenV2 --- -# FakeBoeblingenV2[¶](#fakeboeblingenv2 "Permalink to this headline") +# FakeBoeblingenV2 -`FakeBoeblingenV2` +`FakeBoeblingenV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/boeblingen/fake_boeblingen.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogota.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogota.md index f7f7dd62d0c..d841c3560c8 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogota.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogota.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeBogota --- -# FakeBogota[¶](#fakebogota "Permalink to this headline") +# FakeBogota -`FakeBogota` +`FakeBogota`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogotaV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogotaV2.md index dd1cd4cb0ec..f3ea6bf178c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogotaV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBogotaV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeBogotaV2 --- -# FakeBogotaV2[¶](#fakebogotav2 "Permalink to this headline") +# FakeBogotaV2 -`FakeBogotaV2` +`FakeBogotaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/bogota/fake_bogota.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklyn.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklyn.md index 75d1fbc31d7..6bc1208ebd3 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklyn.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklyn.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeBrooklyn --- -# FakeBrooklyn[¶](#fakebrooklyn "Permalink to this headline") +# FakeBrooklyn -`FakeBrooklyn` +`FakeBrooklyn`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklynV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklynV2.md index c4f8ca91510..2bce1cc001b 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklynV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBrooklynV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeBrooklynV2 --- -# FakeBrooklynV2[¶](#fakebrooklynv2 "Permalink to this headline") +# FakeBrooklynV2 -`FakeBrooklynV2` +`FakeBrooklynV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/brooklyn/fake_brooklyn.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlington.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlington.md index 493492ade0d..75df2efed43 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlington.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlington.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeBurlington --- -# FakeBurlington[¶](#fakeburlington "Permalink to this headline") +# FakeBurlington -`FakeBurlington` +`FakeBurlington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlingtonV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlingtonV2.md index 3ace83112cc..c54b5e1a37f 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlingtonV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeBurlingtonV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeBurlingtonV2 --- -# FakeBurlingtonV2[¶](#fakeburlingtonv2 "Permalink to this headline") +# FakeBurlingtonV2 -`FakeBurlingtonV2` +`FakeBurlingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/burlington/fake_burlington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairo.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairo.md index 8f971ff9c85..73dfd91f137 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairo.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairo.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeCairo --- -# FakeCairo[¶](#fakecairo "Permalink to this headline") +# FakeCairo -`FakeCairo` +`FakeCairo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairoV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairoV2.md index 045b534f10c..7da0caa832e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairoV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCairoV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeCairoV2 --- -# FakeCairoV2[¶](#fakecairov2 "Permalink to this headline") +# FakeCairoV2 -`FakeCairoV2` +`FakeCairoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cairo/fake_cairo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridge.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridge.md index d88861648c1..c2c68106766 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridge.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridge.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeCambridge --- -# FakeCambridge[¶](#fakecambridge "Permalink to this headline") +# FakeCambridge -`FakeCambridge` +`FakeCambridge`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridgeV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridgeV2.md index 3a91819a244..56dd58ddcfa 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridgeV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCambridgeV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeCambridgeV2 --- -# FakeCambridgeV2[¶](#fakecambridgev2 "Permalink to this headline") +# FakeCambridgeV2 -`FakeCambridgeV2` +`FakeCambridgeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/cambridge/fake_cambridge.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablanca.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablanca.md index feddb0259d7..8baeffee498 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablanca.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablanca.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeCasablanca --- -# FakeCasablanca[¶](#fakecasablanca "Permalink to this headline") +# FakeCasablanca -`FakeCasablanca` +`FakeCasablanca`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablancaV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablancaV2.md index b26dff5a739..46f12132c29 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablancaV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeCasablancaV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeCasablancaV2 --- -# FakeCasablancaV2[¶](#fakecasablancav2 "Permalink to this headline") +# FakeCasablancaV2 -`FakeCasablancaV2` +`FakeCasablancaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/casablanca/fake_casablanca.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssex.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssex.md index 521d0169758..74585894ad8 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssex.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssex.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeEssex --- -# FakeEssex[¶](#fakeessex "Permalink to this headline") +# FakeEssex -`FakeEssex` +`FakeEssex`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssexV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssexV2.md index 03f6d8d87e4..9d2149d7e71 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssexV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeEssexV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeEssexV2 --- -# FakeEssexV2[¶](#fakeessexv2 "Permalink to this headline") +# FakeEssexV2 -`FakeEssexV2` +`FakeEssexV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/essex/fake_essex.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGeneva.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGeneva.md index e39fcef8930..b334fd24c68 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGeneva.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGeneva.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeGeneva --- -# FakeGeneva[¶](#fakegeneva "Permalink to this headline") +# FakeGeneva -`FakeGeneva` +`FakeGeneva`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/geneva/fake_geneva.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupe.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupe.md index ac74b688c3e..d44da06e21e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupe.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupe.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeGuadalupe --- -# FakeGuadalupe[¶](#fakeguadalupe "Permalink to this headline") +# FakeGuadalupe -`FakeGuadalupe` +`FakeGuadalupe`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupeV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupeV2.md index 6c99fa38a5a..9214437bbc2 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupeV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeGuadalupeV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeGuadalupeV2 --- -# FakeGuadalupeV2[¶](#fakeguadalupev2 "Permalink to this headline") +# FakeGuadalupeV2 -`FakeGuadalupeV2` +`FakeGuadalupeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/guadalupe/fake_guadalupe.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoi.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoi.md index aed210e59f1..78df172b18b 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoi.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoi.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeHanoi --- -# FakeHanoi[¶](#fakehanoi "Permalink to this headline") +# FakeHanoi -`FakeHanoi` +`FakeHanoi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoiV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoiV2.md index b31f79e7e6b..ba740afea96 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoiV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeHanoiV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeHanoiV2 --- -# FakeHanoiV2[¶](#fakehanoiv2 "Permalink to this headline") +# FakeHanoiV2 -`FakeHanoiV2` +`FakeHanoiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/hanoi/fake_hanoi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakarta.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakarta.md index 0ef600530e5..32d971597b5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakarta.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakarta.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeJakarta --- -# FakeJakarta[¶](#fakejakarta "Permalink to this headline") +# FakeJakarta -`FakeJakarta` +`FakeJakarta`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakartaV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakartaV2.md index 59775744c66..69d32b8bf80 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakartaV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJakartaV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeJakartaV2 --- -# FakeJakartaV2[¶](#fakejakartav2 "Permalink to this headline") +# FakeJakartaV2 -`FakeJakartaV2` +`FakeJakartaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/jakarta/fake_jakarta.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburg.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburg.md index 334017e7b69..456a82ff4b1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburg.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburg.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeJohannesburg --- -# FakeJohannesburg[¶](#fakejohannesburg "Permalink to this headline") +# FakeJohannesburg -`FakeJohannesburg` +`FakeJohannesburg`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburgV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburgV2.md index 513a09838f2..a873bcb8334 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburgV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeJohannesburgV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeJohannesburgV2 --- -# FakeJohannesburgV2[¶](#fakejohannesburgv2 "Permalink to this headline") +# FakeJohannesburgV2 -`FakeJohannesburgV2` +`FakeJohannesburgV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/johannesburg/fake_johannesburg.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkata.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkata.md index 8f0f1592646..f4f37145c8a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkata.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkata.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeKolkata --- -# FakeKolkata[¶](#fakekolkata "Permalink to this headline") +# FakeKolkata -`FakeKolkata` +`FakeKolkata`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkataV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkataV2.md index 623a6e471b0..026564eb148 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkataV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeKolkataV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeKolkataV2 --- -# FakeKolkataV2[¶](#fakekolkatav2 "Permalink to this headline") +# FakeKolkataV2 -`FakeKolkataV2` +`FakeKolkataV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/kolkata/fake_kolkata.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagos.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagos.md index e840a76d672..d1916d4c750 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagos.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagos.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeLagos --- -# FakeLagos[¶](#fakelagos "Permalink to this headline") +# FakeLagos -`FakeLagos` +`FakeLagos`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagosV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagosV2.md index 511322fc993..ffde37f6f60 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagosV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLagosV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeLagosV2 --- -# FakeLagosV2[¶](#fakelagosv2 "Permalink to this headline") +# FakeLagosV2 -`FakeLagosV2` +`FakeLagosV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lagos/fake_lagos.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLima.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLima.md index ba286f63dce..2931b4d6e7c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLima.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLima.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeLima --- -# FakeLima[¶](#fakelima "Permalink to this headline") +# FakeLima -`FakeLima` +`FakeLima`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLimaV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLimaV2.md index fa6cea57b68..5fb7ac2df41 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLimaV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLimaV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeLimaV2 --- -# FakeLimaV2[¶](#fakelimav2 "Permalink to this headline") +# FakeLimaV2 -`FakeLimaV2` +`FakeLimaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/lima/fake_lima.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondon.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondon.md index 4edadd50328..8c39eaef396 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondon.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondon.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeLondon --- -# FakeLondon[¶](#fakelondon "Permalink to this headline") +# FakeLondon -`FakeLondon` +`FakeLondon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondonV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondonV2.md index a133879bfd4..9d22cfbdaca 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondonV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeLondonV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeLondonV2 --- -# FakeLondonV2[¶](#fakelondonv2 "Permalink to this headline") +# FakeLondonV2 -`FakeLondonV2` +`FakeLondonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/london/fake_london.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattan.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattan.md index 5ec6b5ee0ed..c349edd6143 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattan.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattan.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeManhattan --- -# FakeManhattan[¶](#fakemanhattan "Permalink to this headline") +# FakeManhattan -`FakeManhattan` +`FakeManhattan`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattanV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattanV2.md index 925771c5e6e..4555cafdae9 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattanV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManhattanV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeManhattanV2 --- -# FakeManhattanV2[¶](#fakemanhattanv2 "Permalink to this headline") +# FakeManhattanV2 -`FakeManhattanV2` +`FakeManhattanV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manhattan/fake_manhattan.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManila.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManila.md index b34f6234d75..e504670663e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManila.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManila.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeManila --- -# FakeManila[¶](#fakemanila "Permalink to this headline") +# FakeManila -`FakeManila` +`FakeManila`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManilaV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManilaV2.md index 262b0d653b3..36eff58cd35 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManilaV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeManilaV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeManilaV2 --- -# FakeManilaV2[¶](#fakemanilav2 "Permalink to this headline") +# FakeManilaV2 -`FakeManilaV2` +`FakeManilaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/manila/fake_manila.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourne.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourne.md index 9fcfd12f8f2..e1fc2030837 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourne.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourne.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeMelbourne --- -# FakeMelbourne[¶](#fakemelbourne "Permalink to this headline") +# FakeMelbourne -`FakeMelbourne` +`FakeMelbourne`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -60,7 +60,7 @@ str -`FakeMelbourne.properties()` +`FakeMelbourne.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourneV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourneV2.md index 666b6ff2ff9..9821cc122fb 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourneV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMelbourneV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeMelbourneV2 --- -# FakeMelbourneV2[¶](#fakemelbournev2 "Permalink to this headline") +# FakeMelbourneV2 -`FakeMelbourneV2` +`FakeMelbourneV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/melbourne/fake_melbourne.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontreal.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontreal.md index fa29a857086..96bc87423e4 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontreal.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontreal.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeMontreal --- -# FakeMontreal[¶](#fakemontreal "Permalink to this headline") +# FakeMontreal -`FakeMontreal` +`FakeMontreal`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontrealV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontrealV2.md index 44d8d9f7337..843cbd9b08c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontrealV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMontrealV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeMontrealV2 --- -# FakeMontrealV2[¶](#fakemontrealv2 "Permalink to this headline") +# FakeMontrealV2 -`FakeMontrealV2` +`FakeMontrealV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/montreal/fake_montreal.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbai.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbai.md index 96f3a7dcf8a..9f2ee0eacbf 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbai.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbai.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeMumbai --- -# FakeMumbai[¶](#fakemumbai "Permalink to this headline") +# FakeMumbai -`FakeMumbai` +`FakeMumbai`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md index 6f174f62df6..bcee926beda 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiFractionalCX.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeMumbaiFractionalCX --- -# FakeMumbaiFractionalCX[¶](#fakemumbaifractionalcx "Permalink to this headline") +# FakeMumbaiFractionalCX -`FakeMumbaiFractionalCX` +`FakeMumbaiFractionalCX`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Bases: [`qiskit.providers.backend.BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.backend.BackendV2") @@ -131,7 +131,7 @@ The Qubit measurement stimulus line -`FakeMumbaiFractionalCX.qubit_properties(qubit)` +`FakeMumbaiFractionalCX.qubit_properties(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Return QubitProperties for a given qubit. @@ -157,7 +157,7 @@ qubit\_properties -`FakeMumbaiFractionalCX.run(run_input, **options)` +`FakeMumbaiFractionalCX.run(run_input, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_mumbai_v2.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiV2.md index 2cedb0cdffc..b540e939c86 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeMumbaiV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeMumbaiV2 --- -# FakeMumbaiV2[¶](#fakemumbaiv2 "Permalink to this headline") +# FakeMumbaiV2 -`FakeMumbaiV2` +`FakeMumbaiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/mumbai/fake_mumbai.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobi.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobi.md index b6e8b2371e4..bb93bb14f02 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobi.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobi.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeNairobi --- -# FakeNairobi[¶](#fakenairobi "Permalink to this headline") +# FakeNairobi -`FakeNairobi` +`FakeNairobi`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobiV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobiV2.md index 470f49bd94a..c2b3df68f70 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobiV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeNairobiV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeNairobiV2 --- -# FakeNairobiV2[¶](#fakenairobiv2 "Permalink to this headline") +# FakeNairobiV2 -`FakeNairobiV2` +`FakeNairobiV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/nairobi/fake_nairobi.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse2Q.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse2Q.md index b3159bbd23f..1cdd8301ef5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse2Q.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse2Q.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeOpenPulse2Q --- -# FakeOpenPulse2Q[¶](#fakeopenpulse2q "Permalink to this headline") +# FakeOpenPulse2Q -`FakeOpenPulse2Q` +`FakeOpenPulse2Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -45,7 +45,7 @@ the configuration for the backend. -`FakeOpenPulse2Q.defaults()` +`FakeOpenPulse2Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Return the default pulse-related settings provided by the backend (such as gate to Schedule mappings). @@ -69,7 +69,7 @@ str -`FakeOpenPulse2Q.properties()` +`FakeOpenPulse2Q.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_2q.py "view source code") Return the measured characteristics of the backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse3Q.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse3Q.md index e3190be3aeb..e2bede2330b 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse3Q.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOpenPulse3Q.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeOpenPulse3Q --- -# FakeOpenPulse3Q[¶](#fakeopenpulse3q "Permalink to this headline") +# FakeOpenPulse3Q -`FakeOpenPulse3Q` +`FakeOpenPulse3Q`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -45,7 +45,7 @@ the configuration for the backend. -`FakeOpenPulse3Q.defaults()` +`FakeOpenPulse3Q.defaults()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_openpulse_3q.py "view source code") ### name diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOslo.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOslo.md index 0d01a6c3825..8bfc3d057ad 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOslo.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOslo.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeOslo --- -# FakeOslo[¶](#fakeoslo "Permalink to this headline") +# FakeOslo -`FakeOslo` +`FakeOslo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/oslo/fake_oslo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurense.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurense.md index 0db4b3fc116..ba842fa11a0 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurense.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurense.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeOurense --- -# FakeOurense[¶](#fakeourense "Permalink to this headline") +# FakeOurense -`FakeOurense` +`FakeOurense`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurenseV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurenseV2.md index 7e70387b8ef..adff695a4cd 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurenseV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeOurenseV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeOurenseV2 --- -# FakeOurenseV2[¶](#fakeourensev2 "Permalink to this headline") +# FakeOurenseV2 -`FakeOurenseV2` +`FakeOurenseV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/ourense/fake_ourense.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParis.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParis.md index f9c0ebbb06e..0008e7f2c24 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParis.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParis.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeParis --- -# FakeParis[¶](#fakeparis "Permalink to this headline") +# FakeParis -`FakeParis` +`FakeParis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParisV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParisV2.md index 9ab2ab54397..e27a9f8070d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParisV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeParisV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeParisV2 --- -# FakeParisV2[¶](#fakeparisv2 "Permalink to this headline") +# FakeParisV2 -`FakeParisV2` +`FakeParisV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/paris/fake_paris.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePerth.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePerth.md index fdf0207e4c4..f352249466e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePerth.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePerth.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakePerth --- -# FakePerth[¶](#fakeperth "Permalink to this headline") +# FakePerth -`FakePerth` +`FakePerth`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/perth/fake_perth.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsie.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsie.md index e8fd8ff31ba..ca0e6f34384 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsie.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsie.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakePoughkeepsie --- -# FakePoughkeepsie[¶](#fakepoughkeepsie "Permalink to this headline") +# FakePoughkeepsie -`FakePoughkeepsie` +`FakePoughkeepsie`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -64,7 +64,7 @@ str -`FakePoughkeepsie.properties()` +`FakePoughkeepsie.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Returns a snapshot of device properties diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsieV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsieV2.md index c9cb1caef68..256a1bf08b1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsieV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePoughkeepsieV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakePoughkeepsieV2 --- -# FakePoughkeepsieV2[¶](#fakepoughkeepsiev2 "Permalink to this headline") +# FakePoughkeepsieV2 -`FakePoughkeepsieV2` +`FakePoughkeepsieV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/poughkeepsie/fake_poughkeepsie.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePrague.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePrague.md index a043bd16be1..e2c1bda1b89 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePrague.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakePrague.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakePrague --- -# FakePrague[¶](#fakeprague "Permalink to this headline") +# FakePrague -`FakePrague` +`FakePrague`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/prague/fake_prague.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProvider.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProvider.md index ea8192bb876..9fe4b563e54 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProvider.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProvider.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeProvider --- -# FakeProvider[¶](#fakeprovider "Permalink to this headline") +# FakeProvider -`FakeProvider` +`FakeProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -24,7 +24,7 @@ Only filtering backends by name is implemented. This class contains all fake V1 -`FakeProvider.backends(name=None, **kwargs)` +`FakeProvider.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a list of backends matching the specified filtering. @@ -47,7 +47,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`FakeProvider.get_backend(name=None, **kwargs)` +`FakeProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProviderForBackendV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProviderForBackendV2.md index f27acc90c93..857824cbe28 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProviderForBackendV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeProviderForBackendV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeProviderForBackendV2 --- -# FakeProviderForBackendV2[¶](#fakeproviderforbackendv2 "Permalink to this headline") +# FakeProviderForBackendV2 -`FakeProviderForBackendV2` +`FakeProviderForBackendV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -24,7 +24,7 @@ Only filtering backends by name is implemented. This class contains all fake V2 -`FakeProviderForBackendV2.backends(name=None, **kwargs)` +`FakeProviderForBackendV2.backends(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a list of backends matching the specified filtering. @@ -47,7 +47,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`FakeProviderForBackendV2.get_backend(name=None, **kwargs)` +`FakeProviderForBackendV2.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_provider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQasmSimulator.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQasmSimulator.md index 3beb5893f1f..327ea9712dc 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQasmSimulator.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQasmSimulator.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeQasmSimulator --- -# FakeQasmSimulator[¶](#fakeqasmsimulator "Permalink to this headline") +# FakeQasmSimulator -`FakeQasmSimulator` +`FakeQasmSimulator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -61,7 +61,7 @@ str -`FakeQasmSimulator.properties()` +`FakeQasmSimulator.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/fake_qasm_simulator.py "view source code") Return backend properties diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuito.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuito.md index c7fd9e22a09..d7631210be5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuito.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuito.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeQuito --- -# FakeQuito[¶](#fakequito "Permalink to this headline") +# FakeQuito -`FakeQuito` +`FakeQuito`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuitoV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuitoV2.md index 5673bd29f5c..e3f9ab018c0 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuitoV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeQuitoV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeQuitoV2 --- -# FakeQuitoV2[¶](#fakequitov2 "Permalink to this headline") +# FakeQuitoV2 -`FakeQuitoV2` +`FakeQuitoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/quito/fake_quito.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochester.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochester.md index 279f6901ecf..4083d8b5810 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochester.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochester.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeRochester --- -# FakeRochester[¶](#fakerochester "Permalink to this headline") +# FakeRochester -`FakeRochester` +`FakeRochester`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochesterV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochesterV2.md index 6f6da8d75fa..3224cd37757 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochesterV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRochesterV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeRochesterV2 --- -# FakeRochesterV2[¶](#fakerochesterv2 "Permalink to this headline") +# FakeRochesterV2 -`FakeRochesterV2` +`FakeRochesterV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rochester/fake_rochester.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRome.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRome.md index 210b01f9d31..bda625625e0 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRome.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRome.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeRome --- -# FakeRome[¶](#fakerome "Permalink to this headline") +# FakeRome -`FakeRome` +`FakeRome`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRomeV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRomeV2.md index 295fc762c64..07afc5080eb 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRomeV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRomeV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeRomeV2 --- -# FakeRomeV2[¶](#fakeromev2 "Permalink to this headline") +# FakeRomeV2 -`FakeRomeV2` +`FakeRomeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rome/fake_rome.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRueschlikon.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRueschlikon.md index 8fb64d4518d..83fe3fc50a9 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRueschlikon.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeRueschlikon.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeRueschlikon --- -# FakeRueschlikon[¶](#fakerueschlikon "Permalink to this headline") +# FakeRueschlikon -`FakeRueschlikon` +`FakeRueschlikon`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/rueschlikon/fake_rueschlikon.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiago.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiago.md index 647d424296f..0a9cda4b1b7 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiago.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiago.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeSantiago --- -# FakeSantiago[¶](#fakesantiago "Permalink to this headline") +# FakeSantiago -`FakeSantiago` +`FakeSantiago`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiagoV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiagoV2.md index aaa661c21ad..894541fbcd5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiagoV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSantiagoV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeSantiagoV2 --- -# FakeSantiagoV2[¶](#fakesantiagov2 "Permalink to this headline") +# FakeSantiagoV2 -`FakeSantiagoV2` +`FakeSantiagoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/santiago/fake_santiago.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSherbrooke.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSherbrooke.md index 6a6bf5ba74f..9e48023d5fd 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSherbrooke.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSherbrooke.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeSherbrooke --- -# FakeSherbrooke[¶](#fakesherbrooke "Permalink to this headline") +# FakeSherbrooke -`FakeSherbrooke` +`FakeSherbrooke`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sherbrooke/fake_sherbrooke.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingapore.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingapore.md index 7b1c3014f07..9dc4a0cfb9d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingapore.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingapore.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeSingapore --- -# FakeSingapore[¶](#fakesingapore "Permalink to this headline") +# FakeSingapore -`FakeSingapore` +`FakeSingapore`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingaporeV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingaporeV2.md index 53335e75b0b..2855f535d10 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingaporeV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSingaporeV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeSingaporeV2 --- -# FakeSingaporeV2[¶](#fakesingaporev2 "Permalink to this headline") +# FakeSingaporeV2 -`FakeSingaporeV2` +`FakeSingaporeV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/singapore/fake_singapore.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydney.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydney.md index ca47eca6402..bfd7b52a9c2 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydney.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydney.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeSydney --- -# FakeSydney[¶](#fakesydney "Permalink to this headline") +# FakeSydney -`FakeSydney` +`FakeSydney`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydneyV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydneyV2.md index 94c526d540f..24f19f6c7da 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydneyV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeSydneyV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeSydneyV2 --- -# FakeSydneyV2[¶](#fakesydneyv2 "Permalink to this headline") +# FakeSydneyV2 -`FakeSydneyV2` +`FakeSydneyV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/sydney/fake_sydney.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTenerife.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTenerife.md index 1cae0d73750..d22938870ea 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTenerife.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTenerife.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeTenerife --- -# FakeTenerife[¶](#faketenerife "Permalink to this headline") +# FakeTenerife -`FakeTenerife` +`FakeTenerife`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -62,7 +62,7 @@ str -`FakeTenerife.properties()` +`FakeTenerife.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tenerife/fake_tenerife.py "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTokyo.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTokyo.md index 1568aabccaf..adbd05d19c8 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTokyo.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTokyo.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeTokyo --- -# FakeTokyo[¶](#faketokyo "Permalink to this headline") +# FakeTokyo -`FakeTokyo` +`FakeTokyo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackend` @@ -64,7 +64,7 @@ str -`FakeTokyo.properties()` +`FakeTokyo.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/tokyo/fake_tokyo.py "view source code") Returns a snapshot of device properties as recorded on 8/30/19. diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeToronto.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeToronto.md index c766a694b53..f822a7771d4 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeToronto.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeToronto.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeToronto --- -# FakeToronto[¶](#faketoronto "Permalink to this headline") +# FakeToronto -`FakeToronto` +`FakeToronto`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTorontoV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTorontoV2.md index af7eb908d2e..9d02a92cff6 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTorontoV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeTorontoV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeTorontoV2 --- -# FakeTorontoV2[¶](#faketorontov2 "Permalink to this headline") +# FakeTorontoV2 -`FakeTorontoV2` +`FakeTorontoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/toronto/fake_toronto.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValencia.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValencia.md index 7e3433c083d..ef73876d251 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValencia.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValencia.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeValencia --- -# FakeValencia[¶](#fakevalencia "Permalink to this headline") +# FakeValencia -`FakeValencia` +`FakeValencia`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValenciaV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValenciaV2.md index e6535534dab..1e3538c25c2 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValenciaV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeValenciaV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeValenciaV2 --- -# FakeValenciaV2[¶](#fakevalenciav2 "Permalink to this headline") +# FakeValenciaV2 -`FakeValenciaV2` +`FakeValenciaV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/valencia/fake_valencia.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigo.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigo.md index e65c9ce1f8c..0b1edf89806 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigo.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigo.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeVigo --- -# FakeVigo[¶](#fakevigo "Permalink to this headline") +# FakeVigo -`FakeVigo` +`FakeVigo`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigoV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigoV2.md index 4af0d8ee714..baf56833f21 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigoV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeVigoV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeVigoV2 --- -# FakeVigoV2[¶](#fakevigov2 "Permalink to this headline") +# FakeVigoV2 -`FakeVigoV2` +`FakeVigoV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/vigo/fake_vigo.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashington.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashington.md index d3d0ead549e..57412e8b871 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashington.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashington.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeWashington --- -# FakeWashington[¶](#fakewashington "Permalink to this headline") +# FakeWashington -`FakeWashington` +`FakeWashington`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_pulse_backend.FakePulseBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashingtonV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashingtonV2.md index 04132a54aa9..32513514c60 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashingtonV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeWashingtonV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeWashingtonV2 --- -# FakeWashingtonV2[¶](#fakewashingtonv2 "Permalink to this headline") +# FakeWashingtonV2 -`FakeWashingtonV2` +`FakeWashingtonV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/washington/fake_washington.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktown.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktown.md index 0e73626679d..9bde741d22a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktown.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktown.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeYorktown --- -# FakeYorktown[¶](#fakeyorktown "Permalink to this headline") +# FakeYorktown -`FakeYorktown` +`FakeYorktown`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: `qiskit.providers.fake_provider.fake_qasm_backend.FakeQasmBackend` diff --git a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktownV2.md b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktownV2.md index 588c7905da5..fe6ece2e004 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktownV2.md +++ b/docs/api/qiskit/0.41/qiskit.providers.fake_provider.FakeYorktownV2.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.fake_provider.FakeYorktownV2 --- -# FakeYorktownV2[¶](#fakeyorktownv2 "Permalink to this headline") +# FakeYorktownV2 -`FakeYorktownV2` +`FakeYorktownV2`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/fake_provider/backends/yorktown/fake_yorktown.py "view source code") Bases: `qiskit.providers.fake_provider.fake_backend.FakeBackendV2` diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.AccountProvider.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.AccountProvider.md index 62b9400bbca..0e6c0e0b596 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.AccountProvider.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.AccountProvider The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# AccountProvider[¶](#accountprovider "Permalink to this headline") +# AccountProvider -`AccountProvider(credentials, factory)` +`AccountProvider(credentials, factory)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -81,7 +81,7 @@ AccountProvider constructor. -`AccountProvider.backends(name=None, filters=None, **kwargs)` +`AccountProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -150,7 +150,7 @@ a backend matching the filtering. -`AccountProvider.has_service(name)` +`AccountProvider.has_service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") Check if this provider has access to the service. @@ -178,7 +178,7 @@ Whether the provider has access to the service. -`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)` +`AccountProvider.run_circuits(circuits, backend_name, shots=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, seed_transpiler=None, optimization_level=1, init_qubits=True, rep_delay=None, transpiler_options=None, measurement_error_mitigation=False, use_measure_esp=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") Execute the input circuit(s) on a backend using the runtime service. @@ -220,7 +220,7 @@ Runtime job. -`AccountProvider.service(name)` +`AccountProvider.service(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") Return the specified service. @@ -249,7 +249,7 @@ The specified service. -`AccountProvider.services()` +`AccountProvider.services()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/accountprovider.py "view source code") Return all available services. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.BackendJobLimit.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.BackendJobLimit.md index 59055169f5d..17a8f280a65 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.BackendJobLimit.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.BackendJobLimit The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# BackendJobLimit[¶](#backendjoblimit "Permalink to this headline") +# BackendJobLimit -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` +`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/backendjoblimit.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md index 2a5884b283f..b25d3ec7ab7 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat[¶](#qiskit-providers-ibmq-ibmqaccountcredentialsinvalidformat "Permalink to this headline") +# qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat -`IBMQAccountCredentialsInvalidFormat(*message)` +`IBMQAccountCredentialsInvalidFormat(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when the credentials format is invalid. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md index 4e1805e78e8..cd6a57baa8d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken[¶](#qiskit-providers-ibmq-ibmqaccountcredentialsinvalidtoken "Permalink to this headline") +# qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken -`IBMQAccountCredentialsInvalidToken(*message)` +`IBMQAccountCredentialsInvalidToken(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience token is invalid. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md index 7ec26596f36..8ea00a97320 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl[¶](#qiskit-providers-ibmq-ibmqaccountcredentialsinvalidurl "Permalink to this headline") +# qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl -`IBMQAccountCredentialsInvalidUrl(*message)` +`IBMQAccountCredentialsInvalidUrl(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an IBM Quantum Experience URL is invalid. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md index 4db68b44ca6..84b8de0ec65 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.IBMQAccountCredentialsNotFound[¶](#qiskit-providers-ibmq-ibmqaccountcredentialsnotfound "Permalink to this headline") +# qiskit.providers.ibmq.IBMQAccountCredentialsNotFound -`IBMQAccountCredentialsNotFound(*message)` +`IBMQAccountCredentialsNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when credentials are not found. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountError.md index 503416be381..643bf92da68 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.IBMQAccountError[¶](#qiskit-providers-ibmq-ibmqaccounterror "Permalink to this headline") +# qiskit.providers.ibmq.IBMQAccountError -`IBMQAccountError(*message)` +`IBMQAccountError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by account management. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md index db514c97eed..c25adb85512 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound[¶](#qiskit-providers-ibmq-ibmqaccountmultiplecredentialsfound "Permalink to this headline") +# qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound -`IBMQAccountMultipleCredentialsFound(*message)` +`IBMQAccountMultipleCredentialsFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when multiple credentials are found. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackend.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackend.md index 507ac2ebdd6..9491167cd42 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackend.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.IBMQBackend The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# IBMQBackend[¶](#ibmqbackend "Permalink to this headline") +# IBMQBackend -`IBMQBackend(configuration, provider, credentials, api_client)` +`IBMQBackend(configuration, provider, credentials, api_client)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1") @@ -72,7 +72,7 @@ IBMQBackend constructor. -`IBMQBackend.active_jobs(limit=10)` +`IBMQBackend.active_jobs(limit=10)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the unfinished jobs submitted to this backend. @@ -98,7 +98,7 @@ A list of the unfinished jobs for this backend on this provider. -`IBMQBackend.configuration()` +`IBMQBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend configuration. @@ -122,7 +122,7 @@ The configuration for the backend. -`IBMQBackend.defaults(refresh=False)` +`IBMQBackend.defaults(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the pulse defaults for the backend. @@ -148,7 +148,7 @@ The backend pulse defaults or `None` if the backend does not support pulse. -`IBMQBackend.job_limit()` +`IBMQBackend.job_limit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the job limit for the backend. @@ -188,7 +188,7 @@ The job limit for the backend, with this provider. -`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` +`IBMQBackend.jobs(limit=10, skip=0, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the jobs submitted to this backend, subject to optional filtering. @@ -278,7 +278,7 @@ str -`IBMQBackend.properties(refresh=False, datetime=None)` +`IBMQBackend.properties(refresh=False, datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend properties, subject to optional filtering. @@ -331,7 +331,7 @@ the Provider responsible for the backend. -`IBMQBackend.remaining_jobs_count()` +`IBMQBackend.remaining_jobs_count()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the number of remaining jobs that could be submitted to the backend. @@ -361,7 +361,7 @@ The remaining number of jobs a user could submit to the backend, with this provi -`IBMQBackend.reservations(start_datetime=None, end_datetime=None)` +`IBMQBackend.reservations(start_datetime=None, end_datetime=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return backend reservations. @@ -390,7 +390,7 @@ A list of reservations that match the criteria. -`IBMQBackend.retrieve_job(job_id)` +`IBMQBackend.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return a single job submitted to this backend. @@ -418,7 +418,7 @@ The job with the given ID. -`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, live_data_enabled=None, **run_config)` +`IBMQBackend.run(circuits, job_name=None, job_share_level=None, job_tags=None, experiment_id=None, header=None, shots=None, memory=None, qubit_lo_freq=None, meas_lo_freq=None, schedule_los=None, meas_level=None, meas_return=None, memory_slots=None, memory_slot_size=None, rep_time=None, rep_delay=None, init_qubits=None, parameter_binds=None, use_measure_esp=None, live_data_enabled=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Run on the backend. @@ -537,7 +537,7 @@ This method is used to update the options of a backend. If you need to change an -`IBMQBackend.status()` +`IBMQBackend.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackend.py "view source code") Return the backend status. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiError.md index 72aa58c84cc..d39ddfcd6e6 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.IBMQBackendApiError[¶](#qiskit-providers-ibmq-ibmqbackendapierror "Permalink to this headline") +# qiskit.providers.ibmq.IBMQBackendApiError -`IBMQBackendApiError(*message)` +`IBMQBackendApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md index 9c719343fbb..2cef57dcf88 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.IBMQBackendApiProtocolError[¶](#qiskit-providers-ibmq-ibmqbackendapiprotocolerror "Permalink to this headline") +# qiskit.providers.ibmq.IBMQBackendApiProtocolError -`IBMQBackendApiProtocolError(*message)` +`IBMQBackendApiProtocolError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors raised when an unexpected value is received from the server. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendError.md index ae0bfc44c98..fa201148834 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.IBMQBackendError[¶](#qiskit-providers-ibmq-ibmqbackenderror "Permalink to this headline") +# qiskit.providers.ibmq.IBMQBackendError -`IBMQBackendError(*message)` +`IBMQBackendError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the backend modules. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendService.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendService.md index 6ebb1e88fc3..6437c787f0b 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendService.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendService The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# IBMQBackendService[¶](#ibmqbackendservice "Permalink to this headline") +# IBMQBackendService -`IBMQBackendService(provider)` +`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ IBMQBackendService constructor. -`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)` +`IBMQBackendService.backends(name=None, filters=None, timeout=None, min_num_qubits=None, input_allowed=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return all backends accessible via this provider, subject to optional filtering. @@ -102,7 +102,7 @@ The list of available backends that match the filter. -`IBMQBackendService.job_ids(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True)` +`IBMQBackendService.job_ids(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', descending=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of job IDs, subject to optional filtering. @@ -156,7 +156,7 @@ A list of `IBMJob` instances. -`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)` +`IBMQBackendService.jobs(limit=10, skip=0, backend_name=None, status=None, job_name=None, start_datetime=None, end_datetime=None, job_tags=None, job_tags_operator='OR', experiment_id=None, descending=True, db_filter=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a list of jobs, subject to optional filtering. @@ -229,7 +229,7 @@ A list of `IBMQJob` instances. -`IBMQBackendService.my_reservations()` +`IBMQBackendService.my_reservations()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return your upcoming reservations. @@ -249,7 +249,7 @@ A list of your upcoming reservations. -`IBMQBackendService.retrieve_job(job_id)` +`IBMQBackendService.retrieve_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Return a single job. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendValueError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendValueError.md index 1322bd8887b..19ddfe141f5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.IBMQBackendValueError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.IBMQBackendValueError[¶](#qiskit-providers-ibmq-ibmqbackendvalueerror "Permalink to this headline") +# qiskit.providers.ibmq.IBMQBackendValueError -`IBMQBackendValueError(*message)` +`IBMQBackendValueError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Value errors raised by the backend modules. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQError.md index 6c27e395503..3eb1eac3cd4 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.IBMQError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.IBMQError[¶](#qiskit-providers-ibmq-ibmqerror "Permalink to this headline") +# qiskit.providers.ibmq.IBMQError -`IBMQError(*message)` +`IBMQError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Base class for errors raised by the provider modules. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQFactory.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQFactory.md index 59e0eb61d22..df5dabdf140 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQFactory.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.IBMQFactory The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# IBMQFactory[¶](#ibmqfactory "Permalink to this headline") +# IBMQFactory -`IBMQFactory` +`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ IBMQFactory constructor. -`IBMQFactory.active_account()` +`IBMQFactory.active_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return the IBM Quantum Experience account currently in use for the session. @@ -52,7 +52,7 @@ Information about the account currently in the session. -`static IBMQFactory.delete_account()` +`static IBMQFactory.delete_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Delete the saved account from disk. @@ -74,7 +74,7 @@ Delete the saved account from disk. -`IBMQFactory.disable_account()` +`IBMQFactory.disable_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Disable the account currently in use for the session. @@ -94,7 +94,7 @@ Disable the account currently in use for the session. -`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)` +`IBMQFactory.enable_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience for use during the session. @@ -143,7 +143,7 @@ If hub, group, and project are specified, the corresponding provider is returned -`IBMQFactory.get_provider(hub=None, group=None, project=None)` +`IBMQFactory.get_provider(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a provider for a single hub/group/project combination. @@ -173,7 +173,7 @@ A provider that matches the specified criteria. -`IBMQFactory.load_account()` +`IBMQFactory.load_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Authenticate against IBM Quantum Experience from stored credentials. @@ -201,7 +201,7 @@ If the configuration file specifies a default provider, it is returned. Otherwis -`IBMQFactory.providers(hub=None, group=None, project=None)` +`IBMQFactory.providers(hub=None, group=None, project=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Return a list of providers, subject to optional filtering. @@ -227,7 +227,7 @@ A list of providers that match the specified criteria. -`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)` +`static IBMQFactory.save_account(token, url='https://auth.quantum-computing.ibm.com/api', hub=None, group=None, project=None, overwrite=False, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Save the account to disk for future use. @@ -272,7 +272,7 @@ Save the account to disk for future use. -`static IBMQFactory.stored_account()` +`static IBMQFactory.stored_account()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") List the account stored on disk. @@ -297,7 +297,7 @@ A dictionary with information about the account stored on disk. -`static IBMQFactory.update_account(force=False)` +`static IBMQFactory.update_account(force=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/ibmqfactory.py "view source code") Interactive helper for migrating stored credentials to IBM Quantum Experience v2. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQProviderError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQProviderError.md index 6f3d98bf620..0e16c7d54d9 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.IBMQProviderError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.IBMQProviderError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.IBMQProviderError[¶](#qiskit-providers-ibmq-ibmqprovidererror "Permalink to this headline") +# qiskit.providers.ibmq.IBMQProviderError -`IBMQProviderError(*message)` +`IBMQProviderError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/exceptions.py "view source code") Errors related to provider handling. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.RunnerResult.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.RunnerResult.md index bef8bdc1624..591b45e5673 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.RunnerResult.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.RunnerResult.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.RunnerResult The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# RunnerResult[¶](#runnerresult "Permalink to this headline") +# RunnerResult -`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` +`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runner_result.py "view source code") Bases: [`qiskit.result.result.Result`](qiskit.result.Result "qiskit.result.result.Result"), [`qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder`](qiskit.providers.ibmq.runtime.ResultDecoder "qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder") @@ -68,7 +68,7 @@ dict -`classmethod RunnerResult.decode(data)` +`classmethod RunnerResult.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runner_result.py "view source code") Decoding for results from Qiskit runtime jobs. @@ -172,7 +172,7 @@ List\[str] or np.ndarray -`RunnerResult.get_quasiprobabilities(experiment=None)` +`RunnerResult.get_quasiprobabilities(experiment=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runner_result.py "view source code") Get quasiprobabilites associated with one or more experiments. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.Credentials.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.Credentials.md index 07cbcc42d71..d36957508be 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.Credentials.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.Credentials.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.credentials.Credentials The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# Credentials[¶](#credentials "Permalink to this headline") +# Credentials -`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)` +`Credentials(token, url, websockets_url=None, hub=None, group=None, project=None, proxies=None, verify=True, services=None, access_token=None, preferences=None, default_provider=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") Bases: `object` @@ -51,7 +51,7 @@ Credentials constructor. -`Credentials.connection_parameters()` +`Credentials.connection_parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") Construct connection related parameters. @@ -71,7 +71,7 @@ A dictionary with connection-related parameters in the format expected by `reque -`Credentials.is_ibmq()` +`Credentials.is_ibmq()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return whether the credentials represent an IBM Quantum Experience account. @@ -87,7 +87,7 @@ Return whether the credentials represent an IBM Quantum Experience account. -`Credentials.unique_id()` +`Credentials.unique_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/credentials.py "view source code") Return a value that uniquely identifies these credentials. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsError.md index d8a5e298f7e..ed6bef01122 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.credentials.CredentialsError[¶](#qiskit-providers-ibmq-credentials-credentialserror "Permalink to this headline") +# qiskit.providers.ibmq.credentials.CredentialsError -`CredentialsError(*message)` +`CredentialsError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Base class for errors raised during credential management. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md index 4f9409a0f5f..a184675e58f 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.CredentialsNotFoundError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.credentials.CredentialsNotFoundError[¶](#qiskit-providers-ibmq-credentials-credentialsnotfounderror "Permalink to this headline") +# qiskit.providers.ibmq.credentials.CredentialsNotFoundError -`CredentialsNotFoundError(*message)` +`CredentialsNotFoundError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are not found. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md index ce23e16a627..2b452ff59ce 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError[¶](#qiskit-providers-ibmq-credentials-invalidcredentialsformaterror "Permalink to this headline") +# qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError -`InvalidCredentialsFormatError(*message)` +`InvalidCredentialsFormatError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/credentials/exceptions.py "view source code") Errors raised when the credentials are in an invalid format. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.DeviceComponent.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.DeviceComponent.md index 04f5d505d49..269a5f73272 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.DeviceComponent.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.DeviceComponent.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# DeviceComponent[¶](#devicecomponent "Permalink to this headline") +# DeviceComponent -`DeviceComponent` +`DeviceComponent`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/device_component.py "view source code") Bases: `abc.ABC` diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md index 76f40b48bf1..a925238e2a5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.experiment.IBMExperimentEntryExists[¶](#qiskit-providers-ibmq-experiment-ibmexperimententryexists "Permalink to this headline") +# qiskit.providers.ibmq.experiment.IBMExperimentEntryExists -`IBMExperimentEntryExists(*message)` +`IBMExperimentEntryExists(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry already exists. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md index 773b197a33b..52f23f2551a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound[¶](#qiskit-providers-ibmq-experiment-ibmexperimententrynotfound "Permalink to this headline") +# qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound -`IBMExperimentEntryNotFound(*message)` +`IBMExperimentEntryNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Errors raised when an experiment entry cannot be found. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentError.md index 262a64dc178..eb24ac04da6 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.experiment.IBMExperimentError[¶](#qiskit-providers-ibmq-experiment-ibmexperimenterror "Permalink to this headline") +# qiskit.providers.ibmq.experiment.IBMExperimentError -`IBMExperimentError(*message)` +`IBMExperimentError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/exceptions.py "view source code") Base class for errors raised by the experiment service modules. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentService.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentService.md index 5e41b016f48..ae7b128cb28 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentService.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.IBMExperimentService.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# IBMExperimentService[¶](#ibmexperimentservice "Permalink to this headline") +# IBMExperimentService -`IBMExperimentService(provider)` +`IBMExperimentService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Bases: `object` @@ -70,7 +70,7 @@ IBMExperimentService constructor. -`IBMExperimentService.analysis_result(result_id, json_decoder=)` +`IBMExperimentService.analysis_result(result_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -100,7 +100,7 @@ Retrieved analysis result. -`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)` +`IBMExperimentService.analysis_results(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_id=None, result_type=None, result_type_operator=None, backend_name=None, quality=None, verified=None, tags=None, tags_operator='OR', sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all analysis results, with optional filtering. @@ -170,7 +170,7 @@ A list of analysis results. Each analysis result is a dictionary containing the -`IBMExperimentService.backends()` +`IBMExperimentService.backends()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return a list of backends that can be used for experiments. @@ -190,7 +190,7 @@ A list of backends. -`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=ResultQuality.UNKNOWN, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)` +`IBMExperimentService.create_analysis_result(experiment_id, result_data, result_type, device_components=None, tags=None, quality=ResultQuality.UNKNOWN, verified=False, result_id=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new analysis result in the database. @@ -229,7 +229,7 @@ Analysis result ID. -`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)` +`IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Create a new experiment in the database. @@ -288,7 +288,7 @@ Experiment ID. -`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)` +`IBMExperimentService.create_figure(experiment_id, figure, figure_name=None, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Store a new figure in the database. @@ -324,7 +324,7 @@ A tuple of the name and size of the saved figure. -`IBMExperimentService.delete_analysis_result(result_id)` +`IBMExperimentService.delete_analysis_result(result_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an analysis result. @@ -352,7 +352,7 @@ Delete an analysis result. -`IBMExperimentService.delete_experiment(experiment_id)` +`IBMExperimentService.delete_experiment(experiment_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment. @@ -380,7 +380,7 @@ Delete an experiment. -`IBMExperimentService.delete_figure(experiment_id, figure_name)` +`IBMExperimentService.delete_figure(experiment_id, figure_name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Delete an experiment plot. @@ -409,7 +409,7 @@ Delete an experiment plot. -`IBMExperimentService.device_components(backend_name=None)` +`IBMExperimentService.device_components(backend_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Return the device components. @@ -437,7 +437,7 @@ A list of device components if backend\_name is specified. Otherwise a dictionar -`IBMExperimentService.experiment(experiment_id, json_decoder=)` +`IBMExperimentService.experiment(experiment_id, json_decoder=)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve a previously stored experiment. @@ -467,7 +467,7 @@ Retrieved experiment data. -`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)` +`IBMExperimentService.experiments(limit=10, json_decoder=, device_components=None, device_components_operator=None, experiment_type=None, experiment_type_operator=None, backend_name=None, tags=None, tags_operator='OR', start_datetime_after=None, start_datetime_before=None, hub=None, group=None, project=None, exclude_public=False, public_only=False, exclude_mine=False, mine_only=False, parent_id=None, sort_by=None, **filters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve all experiments, with optional filtering. @@ -553,7 +553,7 @@ A list of experiments. Each experiment is a dictionary containing the retrieved -`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)` +`IBMExperimentService.figure(experiment_id, figure_name, file_name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Retrieve an existing figure. @@ -584,7 +584,7 @@ The size of the figure if file\_name is specified. Otherwise the content of the -`IBMExperimentService.save_preferences(auto_save=None)` +`IBMExperimentService.save_preferences(auto_save=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Stores experiment preferences on disk. @@ -610,7 +610,7 @@ Stores experiment preferences on disk. -`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)` +`IBMExperimentService.update_analysis_result(result_id, result_data=None, tags=None, quality=None, verified=None, chisq=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing analysis result. @@ -642,7 +642,7 @@ Update an existing analysis result. -`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)` +`IBMExperimentService.update_experiment(experiment_id, metadata=None, job_ids=None, notes=None, tags=None, share_level=None, end_datetime=None, json_encoder=, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing experiment. @@ -691,7 +691,7 @@ Update an existing experiment. -`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)` +`IBMExperimentService.update_figure(experiment_id, figure, figure_name, sync_upload=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/ibm_experiment_service.py "view source code") Update an existing figure. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.ResultQuality.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.ResultQuality.md index 13f141973af..056c0844049 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.ResultQuality.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.experiment.ResultQuality.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.experiment.ResultQuality The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# ResultQuality[¶](#resultquality "Permalink to this headline") +# ResultQuality -`ResultQuality(value)` +`ResultQuality(value)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/experiment/constants.py "view source code") Bases: `enum.Enum` diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJob.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJob.md index 90105597dce..1d8e683a115 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJob.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJob.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJob The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# IBMQJob[¶](#ibmqjob "Permalink to this headline") +# IBMQJob -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -103,7 +103,7 @@ Return the backend where this job was executed. -`IBMQJob.backend_options()` +`IBMQJob.backend_options()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend configuration options used for this job. @@ -125,7 +125,7 @@ Backend options used for this job. An empty dictionary is returned if the option -`IBMQJob.cancel()` +`IBMQJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Attempt to cancel the job. @@ -169,7 +169,7 @@ Return whether the job has been cancelled. -`IBMQJob.circuits()` +`IBMQJob.circuits()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the circuits or pulse schedules for this job. @@ -189,7 +189,7 @@ The circuits or pulse schedules for this job. An empty list is returned if the c -`IBMQJob.creation_date()` +`IBMQJob.creation_date()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return job creation date, in local time. @@ -225,7 +225,7 @@ Return whether the job has successfully run. -`IBMQJob.error_message()` +`IBMQJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Provide details about the reason of failure. @@ -245,7 +245,7 @@ An error report if the job failed or `None` otherwise. -`IBMQJob.header()` +`IBMQJob.header()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the user header specified for this job. @@ -281,7 +281,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`IBMQJob.job_id()` +`IBMQJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the job ID assigned by the server. @@ -301,7 +301,7 @@ Job ID. -`IBMQJob.name()` +`IBMQJob.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the name assigned to this job. @@ -321,7 +321,7 @@ Job name or `None` if no name was assigned to this job. -`IBMQJob.properties()` +`IBMQJob.properties()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the backend properties for this job. @@ -345,7 +345,7 @@ The backend properties used for this job, or `None` if properties are not availa -`IBMQJob.qobj()` +`IBMQJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the Qobj for this job. @@ -369,7 +369,7 @@ The Qobj for this job, or `None` if the job does not have a Qobj. -`IBMQJob.queue_info()` +`IBMQJob.queue_info()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return queue information for this job. @@ -395,7 +395,7 @@ A [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.Q -`IBMQJob.queue_position(refresh=False)` +`IBMQJob.queue_position(refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the position of the job in the server queue. @@ -423,7 +423,7 @@ Position in the queue or `None` if position is unknown or not applicable. -`IBMQJob.refresh()` +`IBMQJob.refresh()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Obtain the latest job information from the server. @@ -445,7 +445,7 @@ This method may add additional attributes to this job instance, if new informati -`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)` +`IBMQJob.result(timeout=None, wait=5, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the result of the job. @@ -515,7 +515,7 @@ Return whether the job is actively running. -`IBMQJob.scheduling_mode()` +`IBMQJob.scheduling_mode()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the scheduling mode the job is in. @@ -539,7 +539,7 @@ The scheduling mode the job is in or `None` if the information is not available. -`IBMQJob.share_level()` +`IBMQJob.share_level()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the share level of the job. @@ -561,7 +561,7 @@ The share level of the job. -`IBMQJob.status()` +`IBMQJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Query the server for the latest job status. @@ -593,7 +593,7 @@ The status of the job. -`IBMQJob.submit()` +`IBMQJob.submit()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Unsupported method. @@ -617,7 +617,7 @@ Unsupported method. -`IBMQJob.tags()` +`IBMQJob.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the tags assigned to this job. @@ -637,7 +637,7 @@ Tags assigned to this job. -`IBMQJob.time_per_step()` +`IBMQJob.time_per_step()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Return the date and time information on each step of the job processing. @@ -665,7 +665,7 @@ Date and time information on job processing steps, in local time, or `None` if t -`IBMQJob.update_name(name)` +`IBMQJob.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the name associated with this job. @@ -694,7 +694,7 @@ The new name associated with this job. -`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` +`IBMQJob.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Update the tags associated with this job. @@ -738,7 +738,7 @@ The new tags associated with this job. -`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)` +`IBMQJob.wait_for_final_state(timeout=None, wait=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Wait until the job progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobApiError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobApiError.md index 2728334af0d..4df34a82064 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobApiError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobApiError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.job.IBMQJobApiError[¶](#qiskit-providers-ibmq-job-ibmqjobapierror "Permalink to this headline") +# qiskit.providers.ibmq.job.IBMQJobApiError -`IBMQJobApiError(*message)` +`IBMQJobApiError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors that occur unexpectedly when querying the server. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobError.md index 47ad9797ff9..bb6d202f593 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.job.IBMQJobError[¶](#qiskit-providers-ibmq-job-ibmqjoberror "Permalink to this headline") +# qiskit.providers.ibmq.job.IBMQJobError -`IBMQJobError(*message)` +`IBMQJobError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") Base class for errors raised by the job modules. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobFailureError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobFailureError.md index b88ee72581c..3d85b78c2a7 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobFailureError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobFailureError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.job.IBMQJobFailureError[¶](#qiskit-providers-ibmq-job-ibmqjobfailureerror "Permalink to this headline") +# qiskit.providers.ibmq.job.IBMQJobFailureError -`IBMQJobFailureError(*message)` +`IBMQJobFailureError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job failed. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md index 1e05d622bca..0ecbcbb394f 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobInvalidStateError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.job.IBMQJobInvalidStateError[¶](#qiskit-providers-ibmq-job-ibmqjobinvalidstateerror "Permalink to this headline") +# qiskit.providers.ibmq.job.IBMQJobInvalidStateError -`IBMQJobInvalidStateError(*message)` +`IBMQJobInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job is not in a valid state for the operation. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md index d651e741295..c1ead0ab020 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.IBMQJobTimeoutError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.job.IBMQJobTimeoutError[¶](#qiskit-providers-ibmq-job-ibmqjobtimeouterror "Permalink to this headline") +# qiskit.providers.ibmq.job.IBMQJobTimeoutError -`IBMQJobTimeoutError(*message)` +`IBMQJobTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/exceptions.py "view source code") Errors raised when a job operation times out. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.QueueInfo.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.QueueInfo.md index 609613cd787..25ab198806f 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.QueueInfo.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.QueueInfo.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.job.QueueInfo The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# QueueInfo[¶](#queueinfo "Permalink to this headline") +# QueueInfo -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/queueinfo.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ QueueInfo constructor. -`QueueInfo.format()` +`QueueInfo.format()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/queueinfo.py "view source code") Build a user-friendly report for the job queue information. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.job_monitor.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.job_monitor.md index 59434bd94ec..02258c0e57f 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.job_monitor.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.job.job_monitor.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.job.job_monitor The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.job.job\_monitor[¶](#qiskit-providers-ibmq-job-job-monitor "Permalink to this headline") +# qiskit.providers.ibmq.job.job\_monitor -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)` +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.least_busy.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.least_busy.md index 266b705bcff..6f2ab3d12b5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.least_busy.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.least_busy.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.least_busy The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.least\_busy[¶](#qiskit-providers-ibmq-least-busy "Permalink to this headline") +# qiskit.providers.ibmq.least\_busy -`least_busy(backends, reservation_lookahead=60)` +`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManager.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManager.md index 28c12afdd62..3c2aa084a88 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManager.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManager.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# IBMQJobManager[¶](#ibmqjobmanager "Permalink to this headline") +# IBMQJobManager -`IBMQJobManager` +`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Bases: `object` @@ -71,7 +71,7 @@ IBMQJobManager constructor. -`IBMQJobManager.job_sets(name=None)` +`IBMQJobManager.job_sets(name=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return job sets being managed in this session, subject to optional filtering. @@ -95,7 +95,7 @@ A list of managed job sets that match the filter. -`IBMQJobManager.report(detailed=True)` +`IBMQJobManager.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Return a report on the statuses of all jobs managed by this Job Manager. @@ -119,7 +119,7 @@ A report on job statuses. -`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)` +`IBMQJobManager.retrieve_job_set(job_set_id, provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Retrieve a previously submitted job set. @@ -150,7 +150,7 @@ Retrieved job set. -`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)` +`IBMQJobManager.run(experiments, backend, name=None, max_experiments_per_job=None, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Execute a set of circuits or pulse schedules on a backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerError.md index 9f85826b749..b42a0ccb577 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.managed.IBMQJobManagerError[¶](#qiskit-providers-ibmq-managed-ibmqjobmanagererror "Permalink to this headline") +# qiskit.providers.ibmq.managed.IBMQJobManagerError -`IBMQJobManagerError(*message)` +`IBMQJobManagerError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") Base class for errors raise by the Job Manager. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md index 78436dde96b..2746e10a94b 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError[¶](#qiskit-providers-ibmq-managed-ibmqjobmanagerinvalidstateerror "Permalink to this headline") +# qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError -`IBMQJobManagerInvalidStateError(*message)` +`IBMQJobManagerInvalidStateError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when an operation is invoked in an invalid state. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md index d3d68f528a5..56eed9caa99 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound[¶](#qiskit-providers-ibmq-managed-ibmqjobmanagerjobnotfound "Permalink to this headline") +# qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound -`IBMQJobManagerJobNotFound(*message)` +`IBMQJobManagerJobNotFound(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a job cannot be found. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md index 9e605dbd0bc..a4cc22c11d8 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError[¶](#qiskit-providers-ibmq-managed-ibmqjobmanagertimeouterror "Permalink to this headline") +# qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError -`IBMQJobManagerTimeoutError(*message)` +`IBMQJobManagerTimeoutError(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when a Job Manager operation times out. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md index 4e9465a62b5..3760f58b8c8 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet[¶](#qiskit-providers-ibmq-managed-ibmqjobmanagerunknownjobset "Permalink to this headline") +# qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet -`IBMQJobManagerUnknownJobSet(*message)` +`IBMQJobManagerUnknownJobSet(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when the job set ID is unknown. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md index 35364543718..3a3db678e9a 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable[¶](#qiskit-providers-ibmq-managed-ibmqmanagedresultdatanotavailable "Permalink to this headline") +# qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable -`IBMQManagedResultDataNotAvailable(*message)` +`IBMQManagedResultDataNotAvailable(*message)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/exceptions.py "view source code") Errors raised when result data is not available. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJob.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJob.md index 684d34c7abd..b0bf23bce54 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJob.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJob.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJob The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# ManagedJob[¶](#managedjob "Permalink to this headline") +# ManagedJob -`ManagedJob(start_index, experiments_count, job=None)` +`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Bases: `object` @@ -38,7 +38,7 @@ ManagedJob constructor. -`ManagedJob.cancel()` +`ManagedJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Attempt to cancel the job. @@ -54,7 +54,7 @@ Attempt to cancel the job. -`ManagedJob.error_message()` +`ManagedJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Provide details about the reason of failure. @@ -74,7 +74,7 @@ An error report if the job failed or `None` otherwise. -`ManagedJob.qobj()` +`ManagedJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the Qobj for this job. @@ -94,7 +94,7 @@ The Qobj for this job or `None` if the Qobj could not be retrieved. -`ManagedJob.result(timeout=None, partial=False, refresh=False)` +`ManagedJob.result(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Return the result of the job. @@ -124,7 +124,7 @@ Job result or `None` if result could not be retrieved. -`ManagedJob.status()` +`ManagedJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Query the server for job status. @@ -144,7 +144,7 @@ Current job status, or `None` if an error occurred. -`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)` +`ManagedJob.submit(circuits, job_name, backend, executor, submit_lock, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjob.py "view source code") Submit the job. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJobSet.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJobSet.md index 081f57881fa..cad9e0246fa 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJobSet.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedJobSet.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# ManagedJobSet[¶](#managedjobset "Permalink to this headline") +# ManagedJobSet -`ManagedJobSet(name=None, short_id=None)` +`ManagedJobSet(name=None, short_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ ManagedJobSet constructor. -`ManagedJobSet.cancel()` +`ManagedJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Cancel all jobs in this job set. @@ -55,7 +55,7 @@ Cancel all jobs in this job set. -`ManagedJobSet.error_messages()` +`ManagedJobSet.error_messages()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Provide details about job failures. @@ -77,7 +77,7 @@ An error report if one or more jobs failed or `None` otherwise. -`ManagedJobSet.job(experiment)` +`ManagedJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -114,7 +114,7 @@ A tuple of the job used to submit the experiment, or `None` if the job submit fa -`ManagedJobSet.job_set_id()` +`ManagedJobSet.job_set_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the ID of this job set. @@ -134,7 +134,7 @@ ID of this job set. -`ManagedJobSet.jobs()` +`ManagedJobSet.jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return jobs in this job set. @@ -154,7 +154,7 @@ A list of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.j -`ManagedJobSet.managed_jobs()` +`ManagedJobSet.managed_jobs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the managed jobs in this set. @@ -174,7 +174,7 @@ A list of managed jobs. -`ManagedJobSet.name()` +`ManagedJobSet.name()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the name of this job set. @@ -194,7 +194,7 @@ Name of this job set. -`ManagedJobSet.qobjs()` +`ManagedJobSet.qobjs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the Qobjs for the jobs in this set. @@ -214,7 +214,7 @@ A list of Qobjs for the jobs. An entry in the list is `None` if the Qobj could n -`ManagedJobSet.report(detailed=True)` +`ManagedJobSet.report(detailed=True)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return a report on current job statuses. @@ -238,7 +238,7 @@ A report on job statuses. -`ManagedJobSet.results(timeout=None, partial=False, refresh=False)` +`ManagedJobSet.results(timeout=None, partial=False, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the results of the jobs. @@ -289,7 +289,7 @@ A [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults "qiskit.provid -`ManagedJobSet.retrieve_jobs(provider, refresh=False)` +`ManagedJobSet.retrieve_jobs(provider, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Retrieve previously submitted jobs in this set. @@ -315,7 +315,7 @@ Retrieve previously submitted jobs in this set. -`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)` +`ManagedJobSet.run(experiment_list, backend, executor, job_share_level=None, job_tags=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Execute a list of circuits or pulse schedules on a backend. @@ -344,7 +344,7 @@ Execute a list of circuits or pulse schedules on a backend. -`ManagedJobSet.statuses()` +`ManagedJobSet.statuses()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the status of each job in this set. @@ -364,7 +364,7 @@ A list of job statuses. An entry in the list is `None` if the job status could n -`ManagedJobSet.tags()` +`ManagedJobSet.tags()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Return the tags assigned to this job set. @@ -384,7 +384,7 @@ Tags assigned to this job set. -`ManagedJobSet.update_name(name)` +`ManagedJobSet.update_name(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the name of this job set. @@ -408,7 +408,7 @@ The new name associated with this job set. -`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)` +`ManagedJobSet.update_tags(replacement_tags=None, additional_tags=None, removal_tags=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedjobset.py "view source code") Update the tags assigned to this job set. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedResults.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedResults.md index ee0accbfb7a..e498b520a46 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedResults.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.managed.ManagedResults.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.managed.ManagedResults The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# ManagedResults[¶](#managedresults "Permalink to this headline") +# ManagedResults -`ManagedResults(job_set, backend_name, success)` +`ManagedResults(job_set, backend_name, success)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Whether all experiments were successful. -`ManagedResults.combine_results()` +`ManagedResults.combine_results()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Combine results from all jobs into a single Result. @@ -82,7 +82,7 @@ all jobs. -`ManagedResults.data(experiment)` +`ManagedResults.data(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the raw data for an experiment. @@ -118,7 +118,7 @@ Refer to the [`Result.data()`](qiskit.result.Result#data "qiskit.result.Result.d -`ManagedResults.get_counts(experiment)` +`ManagedResults.get_counts(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the histogram data of an experiment. @@ -147,7 +147,7 @@ Refer to the [`Result.get_counts()`](qiskit.result.Result#get_counts "qiskit.res -`ManagedResults.get_memory(experiment)` +`ManagedResults.get_memory(experiment)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the sequence of memory states (readouts) for each shot. The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -176,7 +176,7 @@ Refer to the [`Result.get_memory()`](qiskit.result.Result#get_memory "qiskit.res -`ManagedResults.get_statevector(experiment, decimals=None)` +`ManagedResults.get_statevector(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final statevector of an experiment. @@ -206,7 +206,7 @@ Refer to the [`Result.get_statevector()`](qiskit.result.Result#get_statevector " -`ManagedResults.get_unitary(experiment, decimals=None)` +`ManagedResults.get_unitary(experiment, decimals=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/managed/managedresults.py "view source code") Get the final unitary of an experiment. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.IBMRuntimeService.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.IBMRuntimeService.md index 14d6d093a1b..20296614cd4 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.IBMRuntimeService.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.IBMRuntimeService.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# IBMRuntimeService[¶](#ibmruntimeservice "Permalink to this headline") +# IBMRuntimeService -`IBMRuntimeService(provider)` +`IBMRuntimeService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Bases: `object` @@ -79,7 +79,7 @@ IBMRuntimeService constructor. -`IBMRuntimeService.delete_job(job_id)` +`IBMRuntimeService.delete_job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime job. @@ -106,7 +106,7 @@ Note that this operation cannot be reversed. -`IBMRuntimeService.delete_program(program_id)` +`IBMRuntimeService.delete_program(program_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Delete a runtime program. @@ -131,7 +131,7 @@ Delete a runtime program. -`IBMRuntimeService.job(job_id)` +`IBMRuntimeService.job(job_id)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime job. @@ -160,7 +160,7 @@ Runtime job retrieved. -`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)` +`IBMRuntimeService.jobs(limit=10, skip=0, pending=None, program_id=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve all runtime jobs, subject to optional filtering. @@ -187,7 +187,7 @@ A list of runtime jobs. -`IBMRuntimeService.logout()` +`IBMRuntimeService.logout()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Clears authorization cache on the server. @@ -209,7 +209,7 @@ For better performance, the runtime server caches each user’s authorization in -`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)` +`IBMRuntimeService.pprint_programs(refresh=False, detailed=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Pretty print information about available runtime programs. @@ -232,7 +232,7 @@ Pretty print information about available runtime programs. -`IBMRuntimeService.program(program_id, refresh=False)` +`IBMRuntimeService.program(program_id, refresh=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Retrieve a runtime program. @@ -264,7 +264,7 @@ Runtime program. -`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)` +`IBMRuntimeService.programs(refresh=False, limit=20, skip=0)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Return available runtime programs. @@ -292,7 +292,7 @@ A list of runtime programs. -`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')` +`IBMRuntimeService.run(program_id, options, inputs, callback=None, result_decoder=None, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Execute the runtime program. @@ -335,7 +335,7 @@ A `RuntimeJob` instance representing the execution. -`IBMRuntimeService.set_program_visibility(program_id, public)` +`IBMRuntimeService.set_program_visibility(program_id, public)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Sets a program’s visibility. @@ -361,7 +361,7 @@ Sets a program’s visibility. -`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)` +`IBMRuntimeService.update_program(program_id, data=None, metadata=None, name=None, description=None, max_execution_time=None, spec=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Update a runtime program. @@ -394,7 +394,7 @@ Program metadata can be specified using the metadata parameter or individual par -`IBMRuntimeService.upload_program(data, metadata=None)` +`IBMRuntimeService.upload_program(data, metadata=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/ibm_runtime_service.py "view source code") Upload a runtime program. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ParameterNamespace.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ParameterNamespace.md index 5e22e84010d..8836dda57db 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ParameterNamespace.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ParameterNamespace.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# ParameterNamespace[¶](#parameternamespace "Permalink to this headline") +# ParameterNamespace -`ParameterNamespace(parameters)` +`ParameterNamespace(parameters)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `types.SimpleNamespace` @@ -38,7 +38,7 @@ ParameterNamespace constructor. -`ParameterNamespace.validate()` +`ParameterNamespace.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Validate program input values. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ProgramBackend.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ProgramBackend.md index 1941eeebbe9..d10f5c2176d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ProgramBackend.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ProgramBackend.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# ProgramBackend[¶](#programbackend "Permalink to this headline") +# ProgramBackend -`ProgramBackend(configuration, provider=None, **fields)` +`ProgramBackend(configuration, provider=None, **fields)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Bases: [`qiskit.providers.backend.BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.backend.BackendV1"), `abc.ABC` @@ -146,7 +146,7 @@ the Provider responsible for the backend. -`abstract ProgramBackend.run(circuits, timeout=None, **run_config)` +`abstract ProgramBackend.run(circuits, timeout=None, **run_config)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/program_backend.py "view source code") Run on the backend. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ResultDecoder.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ResultDecoder.md index 5df7634f9da..6e759e9e2f5 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ResultDecoder.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.ResultDecoder.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# ResultDecoder[¶](#resultdecoder "Permalink to this headline") +# ResultDecoder -`ResultDecoder` +`ResultDecoder`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Bases: `object` @@ -43,7 +43,7 @@ Users of your program will need to pass in the subclass when invoking [`qiskit.p -`classmethod ResultDecoder.decode(data)` +`classmethod ResultDecoder.decode(data)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/result_decoder.py "view source code") Decode the result data. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeDecoder.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeDecoder.md index dade6fb4134..2948506732f 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeDecoder.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeDecoder.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# RuntimeDecoder[¶](#runtimedecoder "Permalink to this headline") +# RuntimeDecoder -`RuntimeDecoder(*args, **kwargs)` +`RuntimeDecoder(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.decoder.JSONDecoder` @@ -54,7 +54,7 @@ Return the Python representation of `s` (a `str` instance containing a JSON docu -`RuntimeDecoder.object_hook(obj)` +`RuntimeDecoder.object_hook(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") Called to decode object. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeEncoder.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeEncoder.md index dca36e46b34..8741b9f312f 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeEncoder.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeEncoder.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# RuntimeEncoder[¶](#runtimeencoder "Permalink to this headline") +# RuntimeEncoder -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.encoder.JSONEncoder` @@ -48,7 +48,7 @@ If specified, default is a function that gets called for objects that can’t ot -`RuntimeEncoder.default(obj)` +`RuntimeEncoder.default(obj)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/utils.py "view source code") Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeJob.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeJob.md index c6e25adc4a9..64c1788ecd1 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeJob.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeJob.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# RuntimeJob[¶](#runtimejob "Permalink to this headline") +# RuntimeJob -`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')` +`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Bases: `object` @@ -63,7 +63,7 @@ RuntimeJob constructor. -`RuntimeJob.backend()` +`RuntimeJob.backend()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the backend where this job was executed. @@ -83,7 +83,7 @@ Backend used for the job. -`RuntimeJob.cancel()` +`RuntimeJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel the job. @@ -104,7 +104,7 @@ Cancel the job. -`RuntimeJob.cancel_result_streaming()` +`RuntimeJob.cancel_result_streaming()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Cancel result streaming. @@ -120,7 +120,7 @@ Cancel result streaming. -`RuntimeJob.error_message()` +`RuntimeJob.error_message()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Returns the reason if the job failed. @@ -140,7 +140,7 @@ Error message string or `None`. -`RuntimeJob.job_id()` +`RuntimeJob.job_id()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return a unique ID identifying the job. @@ -160,7 +160,7 @@ Job ID. -`RuntimeJob.logs()` +`RuntimeJob.logs()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return job logs. @@ -188,7 +188,7 @@ Job logs, including standard output and error. -`RuntimeJob.result(timeout=None, wait=5, decoder=None)` +`RuntimeJob.result(timeout=None, wait=5, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the results of the job. @@ -218,7 +218,7 @@ Runtime job result. -`RuntimeJob.status()` +`RuntimeJob.status()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Return the status of the job. @@ -238,7 +238,7 @@ Status of this job. -`RuntimeJob.stream_results(callback, decoder=None)` +`RuntimeJob.stream_results(callback, decoder=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Start streaming job results. @@ -269,7 +269,7 @@ Start streaming job results. -`RuntimeJob.wait_for_final_state(timeout=None, wait=5)` +`RuntimeJob.wait_for_final_state(timeout=None, wait=5)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeOptions.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeOptions.md index ea8a5374a25..00bbef1ab94 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeOptions.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeOptions.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeOptions The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# RuntimeOptions[¶](#runtimeoptions "Permalink to this headline") +# RuntimeOptions -`RuntimeOptions(backend_name=None, image=None, log_level=None)` +`RuntimeOptions(backend_name=None, image=None, log_level=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Class for representing runtime execution options. -`RuntimeOptions.validate()` +`RuntimeOptions.validate()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_options.py "view source code") Validate options. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeProgram.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeProgram.md index a9033be61ee..08a9c28e13f 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeProgram.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.RuntimeProgram.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# RuntimeProgram[¶](#runtimeprogram "Permalink to this headline") +# RuntimeProgram -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)` +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `object` @@ -65,7 +65,7 @@ RuntimeProgram constructor. -`RuntimeProgram.parameters()` +`RuntimeProgram.parameters()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Program parameter namespace. @@ -89,7 +89,7 @@ Program parameter namespace. -`RuntimeProgram.to_dict()` +`RuntimeProgram.to_dict()`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Convert program metadata to dictionary format. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.UserMessenger.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.UserMessenger.md index c0f73ea5272..2b4d47ecec2 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.UserMessenger.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.runtime.UserMessenger.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.runtime.UserMessenger The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# UserMessenger[¶](#usermessenger "Permalink to this headline") +# UserMessenger -`UserMessenger` +`UserMessenger`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ This class can be used when writing a new Qiskit Runtime program. -`UserMessenger.publish(message, encoder=, final=False)` +`UserMessenger.publish(message, encoder=, final=False)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/runtime/program/user_messenger.py "view source code") Publish message. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.seconds_to_duration.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.seconds_to_duration.md index 5bc71eaa307..41ee02fe391 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.seconds_to_duration.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.seconds_to_duration.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.utils.seconds\_to\_duration[¶](#qiskit-providers-ibmq-utils-seconds-to-duration "Permalink to this headline") +# qiskit.providers.ibmq.utils.seconds\_to\_duration -`seconds_to_duration(seconds)` +`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.to_python_identifier.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.to_python_identifier.md index 87d8971db1d..134192118f7 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.to_python_identifier.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.to_python_identifier.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.utils.to_python_identifier The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.utils.to\_python\_identifier[¶](#qiskit-providers-ibmq-utils-to-python-identifier "Permalink to this headline") +# qiskit.providers.ibmq.utils.to\_python\_identifier -`to_python_identifier(name)` +`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.update_qobj_config.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.update_qobj_config.md index 92277dab40c..9b184dae9c9 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.update_qobj_config.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.update_qobj_config.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.utils.update_qobj_config The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.utils.update\_qobj\_config[¶](#qiskit-providers-ibmq-utils-update-qobj-config "Permalink to this headline") +# qiskit.providers.ibmq.utils.update\_qobj\_config -`update_qobj_config(qobj, backend_options=None, noise_model=None)` +`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.utc_to_local.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.utc_to_local.md index 8e8fa0ecc8e..b9c254dcc61 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.utc_to_local.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.utc_to_local.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.utils.utc_to_local The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.utils.utc\_to\_local[¶](#qiskit-providers-ibmq-utils-utc-to-local "Permalink to this headline") +# qiskit.providers.ibmq.utils.utc\_to\_local -`utc_to_local(utc_dt)` +`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. diff --git a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.validate_job_tags.md b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.validate_job_tags.md index ec3cb4dfb73..caf5d797c8d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.validate_job_tags.md +++ b/docs/api/qiskit/0.41/qiskit.providers.ibmq.utils.validate_job_tags.md @@ -10,11 +10,11 @@ python_api_name: qiskit.providers.ibmq.utils.validate_job_tags The package `qiskit-ibmq-provider` is being deprecated and its repo is going to be archived soon. Please transition to the new packages. More information in [https://ibm.biz/provider\_migration\_guide](https://ibm.biz/provider_migration_guide) -# qiskit.providers.ibmq.utils.validate\_job\_tags[¶](#qiskit-providers-ibmq-utils-validate-job-tags "Permalink to this headline") +# qiskit.providers.ibmq.utils.validate\_job\_tags -`validate_job_tags(job_tags, exception)` +`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.20/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.BackendConfiguration.md b/docs/api/qiskit/0.41/qiskit.providers.models.BackendConfiguration.md index 32c8b5d5c30..03d432ab1a9 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.BackendConfiguration.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.models.BackendConfiguration --- -# BackendConfiguration[¶](#backendconfiguration "Permalink to this headline") +# BackendConfiguration -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.41/qiskit.providers.models.BackendProperties.md index 93888a0398b..23442453c57 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.BackendProperties.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.models.BackendProperties --- -# BackendProperties[¶](#backendproperties "Permalink to this headline") +# BackendProperties -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendProperties instance. -`BackendProperties.faulty_gates()` +`BackendProperties.faulty_gates()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty gates. @@ -44,7 +44,7 @@ Return a list of faulty gates. -`BackendProperties.faulty_qubits()` +`BackendProperties.faulty_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return a list of faulty qubits. @@ -52,7 +52,7 @@ Return a list of faulty qubits. -`BackendProperties.frequency(qubit)` +`BackendProperties.frequency(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the frequency of the given qubit. @@ -72,7 +72,7 @@ Frequency of the given qubit. -`classmethod BackendProperties.from_dict(data)` +`classmethod BackendProperties.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Create a new BackendProperties object from a dictionary. @@ -94,7 +94,7 @@ dictionary. -`BackendProperties.gate_error(gate, qubits)` +`BackendProperties.gate_error(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return gate error estimates from backend properties. @@ -115,7 +115,7 @@ Gate error of the given gate and qubit(s). -`BackendProperties.gate_length(gate, qubits)` +`BackendProperties.gate_length(gate, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the duration of the gate in units of seconds. @@ -136,7 +136,7 @@ Gate length of the given gate and qubit(s). -`BackendProperties.gate_property(gate, qubits=None, name=None)` +`BackendProperties.gate_property(gate, qubits=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given gate. @@ -162,7 +162,7 @@ Gate property as a tuple of the value and the time it was measured. -`BackendProperties.is_gate_operational(gate, qubits=None)` +`BackendProperties.is_gate_operational(gate, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given gate. @@ -183,7 +183,7 @@ bool -`BackendProperties.is_qubit_operational(qubit)` +`BackendProperties.is_qubit_operational(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the operational status of the given qubit. @@ -203,7 +203,7 @@ Operational status of the given qubit. -`BackendProperties.qubit_property(qubit, name=None)` +`BackendProperties.qubit_property(qubit, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the property of the given qubit. @@ -228,7 +228,7 @@ Qubit property as a tuple of the value and the time it was measured. -`BackendProperties.readout_error(qubit)` +`BackendProperties.readout_error(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the readout error of the given qubit. @@ -248,7 +248,7 @@ Readout error of the given qubit. -`BackendProperties.readout_length(qubit)` +`BackendProperties.readout_length(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the readout length \[sec] of the given qubit. @@ -268,7 +268,7 @@ Readout length of the given qubit. -`BackendProperties.t1(qubit)` +`BackendProperties.t1(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the T1 time of the given qubit. @@ -288,7 +288,7 @@ T1 time of the given qubit. -`BackendProperties.t2(qubit)` +`BackendProperties.t2(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return the T2 time of the given qubit. @@ -308,7 +308,7 @@ T2 time of the given qubit. -`BackendProperties.to_dict()` +`BackendProperties.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendproperties.py "view source code") Return a dictionary format representation of the BackendProperties. diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.BackendStatus.md b/docs/api/qiskit/0.41/qiskit.providers.models.BackendStatus.md index be7a7ca3e2b..3e752eebd6e 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.BackendStatus.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.models.BackendStatus --- -# BackendStatus[¶](#backendstatus "Permalink to this headline") +# BackendStatus -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") Bases: `object` @@ -36,7 +36,7 @@ Initialize a BackendStatus object -`classmethod BackendStatus.from_dict(data)` +`classmethod BackendStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") Create a new BackendStatus object from a dictionary. @@ -56,7 +56,7 @@ The BackendStatus from the input dictionary. -`BackendStatus.to_dict()` +`BackendStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendstatus.py "view source code") Return a dictionary format representation of the BackendStatus. diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.Command.md b/docs/api/qiskit/0.41/qiskit.providers.models.Command.md index e9a2ce52706..ff4919d535c 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.Command.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.models.Command --- -# Command[¶](#command "Permalink to this headline") +# Command -`Command(name, qubits=None, sequence=None, **kwargs)` +`Command(name, qubits=None, sequence=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ Initialize a Command object -`classmethod Command.from_dict(data)` +`classmethod Command.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Create a new Command object from a dictionary. @@ -59,7 +59,7 @@ qiskit.providers.model.Command -`Command.to_dict()` +`Command.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the Command. diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.GateConfig.md b/docs/api/qiskit/0.41/qiskit.providers.models.GateConfig.md index 4a9242fceec..d18bea2eda0 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.GateConfig.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.models.GateConfig --- -# GateConfig[¶](#gateconfig "Permalink to this headline") +# GateConfig -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Initialize a GateConfig object -`classmethod GateConfig.from_dict(data)` +`classmethod GateConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -72,7 +72,7 @@ The GateConfig from the input dictionary. -`GateConfig.to_dict()` +`GateConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.JobStatus.md b/docs/api/qiskit/0.41/qiskit.providers.models.JobStatus.md index 65cbe36f019..efaf5a8685d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.JobStatus.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.models.JobStatus --- -# JobStatus[¶](#jobstatus "Permalink to this headline") +# JobStatus -`JobStatus(job_id, status, status_msg, **kwargs)` +`JobStatus(job_id, status, status_msg, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ str -`classmethod JobStatus.from_dict(data)` +`classmethod JobStatus.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") Create a new JobStatus object from a dictionary. @@ -74,7 +74,7 @@ qiskit.providers.model.JobStatus -`JobStatus.to_dict()` +`JobStatus.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/jobstatus.py "view source code") Return a dictionary format representation of the JobStatus. diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.PulseBackendConfiguration.md b/docs/api/qiskit/0.41/qiskit.providers.models.PulseBackendConfiguration.md index 53897755e5b..3d2327ada84 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.PulseBackendConfiguration.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.models.PulseBackendConfiguration --- -# PulseBackendConfiguration[¶](#pulsebackendconfiguration "Permalink to this headline") +# PulseBackendConfiguration -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: [`qiskit.providers.models.backendconfiguration.QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.backendconfiguration.QasmBackendConfiguration") @@ -66,7 +66,7 @@ Initialize a backend configuration that contains all the extra configuration tha -`PulseBackendConfiguration.acquire(qubit)` +`PulseBackendConfiguration.acquire(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return the acquisition channel for the given qubit. @@ -86,7 +86,7 @@ Qubit measurement acquisition line. -`PulseBackendConfiguration.control(qubits=None, channel=None)` +`PulseBackendConfiguration.control(qubits=None, channel=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return the secondary drive channel for the given qubit – typically utilized for controlling multiqubit interactions. This channel is derived from other channels. @@ -111,7 +111,7 @@ List of control channels. -`PulseBackendConfiguration.describe(channel)` +`PulseBackendConfiguration.describe(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a basic description of the channel dependency. Derived channels are given weights which describe how their frames are linked to other frames. For instance, the backend could be configured with this setting: @@ -149,7 +149,7 @@ Control channel derivations. -`PulseBackendConfiguration.drive(qubit)` +`PulseBackendConfiguration.drive(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return the drive channel for the given qubit. @@ -169,7 +169,7 @@ Qubit drive channel. -`classmethod PulseBackendConfiguration.from_dict(data)` +`classmethod PulseBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -189,7 +189,7 @@ The GateConfig from the input dictionary. -`PulseBackendConfiguration.get_channel_qubits(channel)` +`PulseBackendConfiguration.get_channel_qubits(channel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of indices for qubits which are operated on directly by the given `channel`. @@ -209,7 +209,7 @@ List of qubits operated on my the given `channel`. -`PulseBackendConfiguration.get_qubit_channels(qubit)` +`PulseBackendConfiguration.get_qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a list of channels which operate on the given `qubit`. @@ -229,7 +229,7 @@ List of `Channel`s operated on my the given `qubit`. -`PulseBackendConfiguration.measure(qubit)` +`PulseBackendConfiguration.measure(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return the measure stimulus channel for the given qubit. @@ -249,7 +249,7 @@ Qubit measurement stimulus line. -`PulseBackendConfiguration.to_dict()` +`PulseBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.PulseDefaults.md b/docs/api/qiskit/0.41/qiskit.providers.models.PulseDefaults.md index 7f9fb4af593..9cec55a818d 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.PulseDefaults.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.models.PulseDefaults --- -# PulseDefaults[¶](#pulsedefaults "Permalink to this headline") +# PulseDefaults -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_e -`classmethod PulseDefaults.from_dict(data)` +`classmethod PulseDefaults.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Create a new PulseDefaults object from a dictionary. @@ -44,7 +44,7 @@ The PulseDefaults from the input dictionary. -`PulseDefaults.to_dict()` +`PulseDefaults.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/pulsedefaults.py "view source code") Return a dictionary format representation of the PulseDefaults. :returns: The dictionary form of the PulseDefaults. :rtype: dict diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.QasmBackendConfiguration.md b/docs/api/qiskit/0.41/qiskit.providers.models.QasmBackendConfiguration.md index 00ebfb7d849..e11f0ae4e07 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.QasmBackendConfiguration.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.models.QasmBackendConfiguration --- -# QasmBackendConfiguration[¶](#qasmbackendconfiguration "Permalink to this headline") +# QasmBackendConfiguration -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -160,7 +160,7 @@ Initialize a QasmBackendConfiguration Object -`classmethod QasmBackendConfiguration.from_dict(data)` +`classmethod QasmBackendConfiguration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Create a new GateConfig object from a dictionary. @@ -180,7 +180,7 @@ The GateConfig from the input dictionary. -`QasmBackendConfiguration.to_dict()` +`QasmBackendConfiguration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the GateConfig. diff --git a/docs/api/qiskit/0.41/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.41/qiskit.providers.models.UchannelLO.md index 5fc4c544bd5..ad04506ab73 100644 --- a/docs/api/qiskit/0.41/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.41/qiskit.providers.models.UchannelLO.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.providers.models.UchannelLO --- -# UchannelLO[¶](#uchannello "Permalink to this headline") +# UchannelLO -`UchannelLO(q, scale)` +`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a UchannelLOSchema object -`classmethod UchannelLO.from_dict(data)` +`classmethod UchannelLO.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Create a new UchannelLO object from a dictionary. @@ -65,7 +65,7 @@ The UchannelLO from the input dictionary. -`UchannelLO.to_dict()` +`UchannelLO.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/providers/models/backendconfiguration.py "view source code") Return a dictionary format representation of the UChannelLO. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.41/qiskit.pulse.InstructionScheduleMap.md index ada98de3a6a..2bb3499aca8 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.InstructionScheduleMap.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.InstructionScheduleMap --- -# InstructionScheduleMap[¶](#instructionschedulemap "Permalink to this headline") +# InstructionScheduleMap -`InstructionScheduleMap` +`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Initialize a circuit instruction to schedule mapper instance. -`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)` +`InstructionScheduleMap.add(instruction, qubits, schedule, arguments=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Add a new known instruction for the given qubits and its mapping to a pulse schedule. @@ -55,7 +55,7 @@ Add a new known instruction for the given qubits and its mapping to a pulse sche -`InstructionScheduleMap.assert_has(instruction, qubits)` +`InstructionScheduleMap.assert_has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Error if the given instruction is not defined. @@ -76,7 +76,7 @@ Error if the given instruction is not defined. -`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)` +`InstructionScheduleMap.get(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return the defined [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") for the given instruction on the given qubits. @@ -101,7 +101,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.get_parameters(instruction, qubits)` +`InstructionScheduleMap.get_parameters(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return the list of parameters taken by the given instruction on the given qubits. @@ -122,7 +122,7 @@ The names of the parameters required by the instruction. -`InstructionScheduleMap.has(instruction, qubits)` +`InstructionScheduleMap.has(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Is the instruction defined for the given qubits? @@ -143,7 +143,7 @@ True iff the instruction is defined. -`InstructionScheduleMap.has_custom_gate()` +`InstructionScheduleMap.has_custom_gate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return `True` if the map has user provided instruction. @@ -155,7 +155,7 @@ Return `True` if the map has user provided instruction. -`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)` +`InstructionScheduleMap.pop(instruction, qubits, *params, **kwparams)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Remove and return the defined schedule for the given instruction on the given qubits. @@ -178,7 +178,7 @@ The Schedule defined for the input. -`InstructionScheduleMap.qubit_instructions(qubits)` +`InstructionScheduleMap.qubit_instructions(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the instruction names that are defined by the backend for the given qubit or qubits. @@ -200,7 +200,7 @@ For 1 qubit, all the 1Q instructions defined. For multiple qubits, all the instr -`InstructionScheduleMap.qubits_with_instruction(instruction)` +`InstructionScheduleMap.qubits_with_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Return a list of the qubits for which the given instruction is defined. Single qubit instructions return a flat list, and multiqubit instructions return a list of ordered tuples. @@ -224,7 +224,7 @@ Qubit indices which have the given instruction defined. This is a list of tuples -`InstructionScheduleMap.remove(instruction, qubits)` +`InstructionScheduleMap.remove(instruction, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instruction_schedule_map.py "view source code") Remove the given instruction from the listing of instructions defined in self. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.41/qiskit.pulse.Schedule.md index 5819bff7498..52c6e4f1d15 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.Schedule.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.Schedule --- -# Schedule[¶](#schedule "Permalink to this headline") +# Schedule -`Schedule(*schedules, name=None, metadata=None)` +`Schedule(*schedules, name=None, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -73,7 +73,7 @@ Create an empty schedule. -`Schedule.append(schedule, name=None, inplace=False)` +`Schedule.append(schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. @@ -96,7 +96,7 @@ $$ -`Schedule.assign_parameters(value_dict, inplace=True)` +`Schedule.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -117,7 +117,7 @@ Schedule with updated parameters. -`Schedule.ch_duration(*channels)` +`Schedule.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -133,7 +133,7 @@ Return the time of the end of the last instruction over the supplied channels. -`Schedule.ch_start_time(*channels)` +`Schedule.ch_start_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return the time of the start of the first instruction over the supplied channels. @@ -149,7 +149,7 @@ Return the time of the start of the first instruction over the supplied channels -`Schedule.ch_stop_time(*channels)` +`Schedule.ch_stop_time(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return maximum start time over supplied channels. @@ -211,7 +211,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` +`Schedule.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -236,7 +236,7 @@ self.filter(args) | self.exclude(args) == self -`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` +`Schedule.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `Schedule` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -259,7 +259,7 @@ If no arguments are provided, `self` is returned. -`Schedule.get_parameters(parameter_name)` +`Schedule.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -281,7 +281,7 @@ Parameter objects that have corresponding name. -`classmethod Schedule.initialize_from(other_program, name=None)` +`classmethod Schedule.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -306,7 +306,7 @@ New schedule object with name and metadata. -`Schedule.insert(start_time, schedule, name=None, inplace=False)` +`Schedule.insert(start_time, schedule, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new schedule with `schedule` inserted into `self` at `start_time`. @@ -325,7 +325,7 @@ Return a new schedule with `schedule` inserted into `self` at `start_time`. -`Schedule.is_parameterized()` +`Schedule.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -337,7 +337,7 @@ Return True iff the instruction is parameterized. -`Schedule.replace(old, new, inplace=False)` +`Schedule.replace(old, new, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with the `old` instruction replaced with a `new` instruction. @@ -398,7 +398,7 @@ The modified schedule with `old` replaced by `new`. -`Schedule.shift(time, name=None, inplace=False)` +`Schedule.shift(time, name=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a schedule shifted forward by `time`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.41/qiskit.pulse.ScheduleBlock.md index b7da580f576..304b38959f8 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.ScheduleBlock.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.ScheduleBlock --- -# ScheduleBlock[¶](#scheduleblock "Permalink to this headline") +# ScheduleBlock -`ScheduleBlock(name=None, metadata=None, alignment_context=None)` +`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -166,7 +166,7 @@ Create an empty schedule block. -`ScheduleBlock.append(block, name=None, inplace=True)` +`ScheduleBlock.append(block, name=None, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new schedule block with `block` appended to the context block. The execution time is automatically assigned when the block is converted into schedule. @@ -192,7 +192,7 @@ Schedule block with appended schedule. -`ScheduleBlock.assign_parameters(value_dict, inplace=True)` +`ScheduleBlock.assign_parameters(value_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Assign the parameters in this schedule according to the input. @@ -217,7 +217,7 @@ Schedule with updated parameters. -`ScheduleBlock.assign_references(subroutine_dict, inplace=True)` +`ScheduleBlock.assign_references(subroutine_dict, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Assign schedules to references. @@ -277,7 +277,7 @@ Schedule block with assigned subroutine. -`ScheduleBlock.ch_duration(*channels)` +`ScheduleBlock.ch_duration(*channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return the time of the end of the last instruction over the supplied channels. @@ -339,7 +339,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` +`ScheduleBlock.exclude(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a `Schedule` with only the instructions from this Schedule *failing* at least one of the provided filters. This method is the complement of py:meth:\~self.filter, so that: @@ -372,7 +372,7 @@ self.filter(args) | self.exclude(args) == self -`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)` +`ScheduleBlock.filter(*filter_funcs, channels=None, instruction_types=None, time_ranges=None, intervals=None, check_subroutine=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a new `Schedule` with only the instructions from this `ScheduleBlock` which pass though the provided filters; i.e. an instruction will be retained iff every function in `filter_funcs` returns `True`, the instruction occurs on a channel type contained in `channels`, the instruction type is contained in `instruction_types`, and the period over which the instruction operates is *fully* contained in one specified in `time_ranges` or `intervals`. @@ -403,7 +403,7 @@ If no arguments are provided, `self` is returned. -`ScheduleBlock.get_parameters(parameter_name)` +`ScheduleBlock.get_parameters(parameter_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Get parameter object bound to this schedule by string name. @@ -443,7 +443,7 @@ Parameter objects that have corresponding name. -`classmethod ScheduleBlock.initialize_from(other_program, name=None)` +`classmethod ScheduleBlock.initialize_from(other_program, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Create new schedule object with metadata of another schedule object. @@ -468,7 +468,7 @@ New block object with name and metadata. -`ScheduleBlock.is_parameterized()` +`ScheduleBlock.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return True iff the instruction is parameterized. @@ -480,7 +480,7 @@ Return True iff the instruction is parameterized. -`ScheduleBlock.is_referenced()` +`ScheduleBlock.is_referenced()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return True iff the current schedule block contains reference to subroutine. @@ -492,7 +492,7 @@ Return True iff the current schedule block contains reference to subroutine. -`ScheduleBlock.is_schedulable()` +`ScheduleBlock.is_schedulable()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return `True` if all durations are assigned. @@ -504,7 +504,7 @@ Return `True` if all durations are assigned. -`ScheduleBlock.replace(old, new, inplace=True)` +`ScheduleBlock.replace(old, new, inplace=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return a `ScheduleBlock` with the `old` component replaced with a `new` component. @@ -526,7 +526,7 @@ The modified schedule block with `old` replaced by `new`. -`ScheduleBlock.scoped_parameters()` +`ScheduleBlock.scoped_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Return unassigned parameters with scoped names. @@ -542,7 +542,7 @@ Return unassigned parameters with scoped names. -`ScheduleBlock.search_parameters(parameter_regex)` +`ScheduleBlock.search_parameters(parameter_regex)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/schedule.py "view source code") Search parameter with regular expression. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.acquire.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.acquire.md index 0c6ffc406aa..ddea77147e4 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.acquire.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.acquire --- -# qiskit.pulse.builder.acquire[¶](#qiskit-pulse-builder-acquire "Permalink to this headline") +# qiskit.pulse.builder.acquire -`acquire(duration, qubit_or_channel, register, **metadata)` +`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.acquire_channel.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.acquire_channel.md index 58969783aa4..4740c15d574 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.acquire_channel.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.acquire_channel.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.acquire_channel --- -# qiskit.pulse.builder.acquire\_channel[¶](#qiskit-pulse-builder-acquire-channel "Permalink to this headline") +# qiskit.pulse.builder.acquire\_channel -`acquire_channel(qubit)` +`acquire_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return `AcquireChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.active_backend.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.active_backend.md index 16328e8984f..70f5c6b76db 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.active_backend.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.active_backend.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.active_backend --- -# qiskit.pulse.builder.active\_backend[¶](#qiskit-pulse-builder-active-backend "Permalink to this headline") +# qiskit.pulse.builder.active\_backend -`active_backend()` +`active_backend()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Get the backend of the currently active builder context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.active_circuit_scheduler_settings.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.active_circuit_scheduler_settings.md index 99846d2fa7c..85676e5fbe7 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.active_circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.active_circuit_scheduler_settings.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings --- -# qiskit.pulse.builder.active\_circuit\_scheduler\_settings[¶](#qiskit-pulse-builder-active-circuit-scheduler-settings "Permalink to this headline") +# qiskit.pulse.builder.active\_circuit\_scheduler\_settings -`active_circuit_scheduler_settings()` +`active_circuit_scheduler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return the current active builder context’s circuit scheduler settings. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.active_transpiler_settings.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.active_transpiler_settings.md index ceeaaf8edae..8c050eead2a 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.active_transpiler_settings.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.active_transpiler_settings.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.active_transpiler_settings --- -# qiskit.pulse.builder.active\_transpiler\_settings[¶](#qiskit-pulse-builder-active-transpiler-settings "Permalink to this headline") +# qiskit.pulse.builder.active\_transpiler\_settings -`active_transpiler_settings()` +`active_transpiler_settings()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return the current active builder context’s transpiler settings. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_equispaced.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_equispaced.md index 07c3fce7d57..82b078baca8 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_equispaced.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_equispaced.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.align_equispaced --- -# qiskit.pulse.builder.align\_equispaced[¶](#qiskit-pulse-builder-align-equispaced "Permalink to this headline") +# qiskit.pulse.builder.align\_equispaced -`align_equispaced(duration)` +`align_equispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Equispaced alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_func.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_func.md index aafd6014570..f527083789b 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_func.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_func.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.align_func --- -# qiskit.pulse.builder.align\_func[¶](#qiskit-pulse-builder-align-func "Permalink to this headline") +# qiskit.pulse.builder.align\_func -`align_func(duration, func)` +`align_func(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Callback defined alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_left.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_left.md index 890acef5443..46e39b38363 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_left.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_left.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.align_left --- -# qiskit.pulse.builder.align\_left[¶](#qiskit-pulse-builder-align-left "Permalink to this headline") +# qiskit.pulse.builder.align\_left -`align_left()` +`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_right.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_right.md index cbd4cf17e70..85ad4f1cf25 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_right.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_right.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.align_right --- -# qiskit.pulse.builder.align\_right[¶](#qiskit-pulse-builder-align-right "Permalink to this headline") +# qiskit.pulse.builder.align\_right -`align_right()` +`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_sequential.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_sequential.md index 678b921f851..32c77294ee5 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.align_sequential.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.align_sequential.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.align_sequential --- -# qiskit.pulse.builder.align\_sequential[¶](#qiskit-pulse-builder-align-sequential "Permalink to this headline") +# qiskit.pulse.builder.align\_sequential -`align_sequential()` +`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.barrier.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.barrier.md index eb45e4892af..7c518c47f59 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.barrier.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.barrier --- -# qiskit.pulse.builder.barrier[¶](#qiskit-pulse-builder-barrier "Permalink to this headline") +# qiskit.pulse.builder.barrier -`barrier(*channels_or_qubits, name=None)` +`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.build.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.build.md index 13641300acc..f5a80ba9fb6 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.build.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.build --- -# qiskit.pulse.builder.build[¶](#qiskit-pulse-builder-build "Permalink to this headline") +# qiskit.pulse.builder.build -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.call.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.call.md index b15e6fb83ef..3bfa5ffb676 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.call.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.call --- -# qiskit.pulse.builder.call[¶](#qiskit-pulse-builder-call "Permalink to this headline") +# qiskit.pulse.builder.call -`call(target, name=None, value_dict=None, **kw_params)` +`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call the subroutine within the currently active builder context with arbitrary parameters which will be assigned to the target program. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.circuit_scheduler_settings.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.circuit_scheduler_settings.md index 60657f63b4c..2690f31f73f 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.circuit_scheduler_settings.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.circuit_scheduler_settings.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.circuit_scheduler_settings --- -# qiskit.pulse.builder.circuit\_scheduler\_settings[¶](#qiskit-pulse-builder-circuit-scheduler-settings "Permalink to this headline") +# qiskit.pulse.builder.circuit\_scheduler\_settings -`circuit_scheduler_settings(**settings)` +`circuit_scheduler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Set the currently active circuit scheduler settings for this context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.control_channels.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.control_channels.md index cc319f40d5e..f8f0dec1afe 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.control_channels.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.control_channels.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.control_channels --- -# qiskit.pulse.builder.control\_channels[¶](#qiskit-pulse-builder-control-channels "Permalink to this headline") +# qiskit.pulse.builder.control\_channels -`control_channels(*qubits)` +`control_channels(*qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return `ControlChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.cx.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.cx.md index aaaa85f6ba4..18cc9c86811 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.cx.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.cx --- -# qiskit.pulse.builder.cx[¶](#qiskit-pulse-builder-cx "Permalink to this headline") +# qiskit.pulse.builder.cx -`cx(control, target)` +`cx(control, target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `CXGate` on the input physical qubits. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.delay.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.delay.md index 27eda591334..3bfc0a741ca 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.delay.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.delay --- -# qiskit.pulse.builder.delay[¶](#qiskit-pulse-builder-delay "Permalink to this headline") +# qiskit.pulse.builder.delay -`delay(duration, channel, name=None)` +`delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Delay on a `channel` for a `duration`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.delay_qubits.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.delay_qubits.md index c318c3f0845..b0d443000c6 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.delay_qubits.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.delay_qubits.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.delay_qubits --- -# qiskit.pulse.builder.delay\_qubits[¶](#qiskit-pulse-builder-delay-qubits "Permalink to this headline") +# qiskit.pulse.builder.delay\_qubits -`delay_qubits(duration, *qubits)` +`delay_qubits(duration, *qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.drive_channel.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.drive_channel.md index c878119923a..4cc8985420a 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.drive_channel.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.drive_channel.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.drive_channel --- -# qiskit.pulse.builder.drive\_channel[¶](#qiskit-pulse-builder-drive-channel "Permalink to this headline") +# qiskit.pulse.builder.drive\_channel -`drive_channel(qubit)` +`drive_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return `DriveChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.frequency_offset.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.frequency_offset.md index 8d87c93af0e..ab753bbf02d 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.frequency_offset.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.frequency_offset.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.frequency_offset --- -# qiskit.pulse.builder.frequency\_offset[¶](#qiskit-pulse-builder-frequency-offset "Permalink to this headline") +# qiskit.pulse.builder.frequency\_offset -`frequency_offset(frequency, *channels, compensate_phase=False)` +`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.measure.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.measure.md index a4482a2ffde..4ae5f943ab5 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.measure.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.measure --- -# qiskit.pulse.builder.measure[¶](#qiskit-pulse-builder-measure "Permalink to this headline") +# qiskit.pulse.builder.measure -`measure(qubits, registers=None)` +`measure(qubits, registers=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Measure a qubit within the currently active builder context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.measure_all.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.measure_all.md index 19aa7b6a1be..32d745d26a8 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.measure_all.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.measure_all.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.measure_all --- -# qiskit.pulse.builder.measure\_all[¶](#qiskit-pulse-builder-measure-all "Permalink to this headline") +# qiskit.pulse.builder.measure\_all -`measure_all()` +`measure_all()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Measure all qubits within the currently active builder context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.measure_channel.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.measure_channel.md index 3cde00d8cfc..b2a6a0b8364 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.measure_channel.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.measure_channel.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.measure_channel --- -# qiskit.pulse.builder.measure\_channel[¶](#qiskit-pulse-builder-measure-channel "Permalink to this headline") +# qiskit.pulse.builder.measure\_channel -`measure_channel(qubit)` +`measure_channel(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return `MeasureChannel` for `qubit` on the active builder backend. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.num_qubits.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.num_qubits.md index 85609464592..64db9937675 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.num_qubits.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.num_qubits.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.num_qubits --- -# qiskit.pulse.builder.num\_qubits[¶](#qiskit-pulse-builder-num-qubits "Permalink to this headline") +# qiskit.pulse.builder.num\_qubits -`num_qubits()` +`num_qubits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Return number of qubits in the currently active backend. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.phase_offset.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.phase_offset.md index a000c0bb4b5..554699927d6 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.phase_offset.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.phase_offset.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.phase_offset --- -# qiskit.pulse.builder.phase\_offset[¶](#qiskit-pulse-builder-phase-offset "Permalink to this headline") +# qiskit.pulse.builder.phase\_offset -`phase_offset(phase, *channels)` +`phase_offset(phase, *channels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Shift the phase of input channels on entry into context and undo on exit. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.play.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.play.md index 4e1a9e10450..84990b4aaa8 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.play.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.play --- -# qiskit.pulse.builder.play[¶](#qiskit-pulse-builder-play "Permalink to this headline") +# qiskit.pulse.builder.play -`play(pulse, channel, name=None)` +`play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Play a `pulse` on a `channel`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.qubit_channels.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.qubit_channels.md index 8906ca13f42..5538e667f20 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.qubit_channels.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.qubit_channels.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.qubit_channels --- -# qiskit.pulse.builder.qubit\_channels[¶](#qiskit-pulse-builder-qubit-channels "Permalink to this headline") +# qiskit.pulse.builder.qubit\_channels -`qubit_channels(qubit)` +`qubit_channels(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Returns the set of channels associated with a qubit. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.reference.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.reference.md index 956087a005b..09565a65d28 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.reference.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.reference.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.reference --- -# qiskit.pulse.builder.reference[¶](#qiskit-pulse-builder-reference "Permalink to this headline") +# qiskit.pulse.builder.reference -`reference(name, *extra_keys)` +`reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Refer to undefined subroutine by string keys. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.samples_to_seconds.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.samples_to_seconds.md index e273cdb49cf..64f1c6dde90 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.samples_to_seconds.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.samples_to_seconds.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.samples_to_seconds --- -# qiskit.pulse.builder.samples\_to\_seconds[¶](#qiskit-pulse-builder-samples-to-seconds "Permalink to this headline") +# qiskit.pulse.builder.samples\_to\_seconds -`samples_to_seconds(samples)` +`samples_to_seconds(samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Obtain the time in seconds that will elapse for the input number of samples on the active backend. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.seconds_to_samples.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.seconds_to_samples.md index c3972ebfa0f..d8ac9114603 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.seconds_to_samples.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.seconds_to_samples.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.seconds_to_samples --- -# qiskit.pulse.builder.seconds\_to\_samples[¶](#qiskit-pulse-builder-seconds-to-samples "Permalink to this headline") +# qiskit.pulse.builder.seconds\_to\_samples -`seconds_to_samples(seconds)` +`seconds_to_samples(seconds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Obtain the number of samples that will elapse in `seconds` on the active backend. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.set_frequency.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.set_frequency.md index de52f132a96..6531e9ad6b4 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.set_frequency.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.set_frequency.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.set_frequency --- -# qiskit.pulse.builder.set\_frequency[¶](#qiskit-pulse-builder-set-frequency "Permalink to this headline") +# qiskit.pulse.builder.set\_frequency -`set_frequency(frequency, channel, name=None)` +`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.set_phase.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.set_phase.md index 8a185492def..28764fb92a6 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.set_phase.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.set_phase.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.set_phase --- -# qiskit.pulse.builder.set\_phase[¶](#qiskit-pulse-builder-set-phase "Permalink to this headline") +# qiskit.pulse.builder.set\_phase -`set_phase(phase, channel, name=None)` +`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.shift_frequency.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.shift_frequency.md index 9b8e7a783c2..b86679ed11d 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.shift_frequency.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.shift_frequency.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.shift_frequency --- -# qiskit.pulse.builder.shift\_frequency[¶](#qiskit-pulse-builder-shift-frequency "Permalink to this headline") +# qiskit.pulse.builder.shift\_frequency -`shift_frequency(frequency, channel, name=None)` +`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.shift_phase.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.shift_phase.md index 24cb0ebc355..78a344c1396 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.shift_phase.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.shift_phase.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.shift_phase --- -# qiskit.pulse.builder.shift\_phase[¶](#qiskit-pulse-builder-shift-phase "Permalink to this headline") +# qiskit.pulse.builder.shift\_phase -`shift_phase(phase, channel, name=None)` +`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.snapshot.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.snapshot.md index 3d5f75c86b5..459cc11755b 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.snapshot.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.snapshot --- -# qiskit.pulse.builder.snapshot[¶](#qiskit-pulse-builder-snapshot "Permalink to this headline") +# qiskit.pulse.builder.snapshot -`snapshot(label, snapshot_type='statevector')` +`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Simulator snapshot. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.transpiler_settings.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.transpiler_settings.md index ac7b94fe747..b86e8ce5c27 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.transpiler_settings.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.transpiler_settings.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.transpiler_settings --- -# qiskit.pulse.builder.transpiler\_settings[¶](#qiskit-pulse-builder-transpiler-settings "Permalink to this headline") +# qiskit.pulse.builder.transpiler\_settings -`transpiler_settings(**settings)` +`transpiler_settings(**settings)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Set the currently active transpiler settings for this context. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.u1.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.u1.md index 6e92416ec29..70b53383520 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.u1.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.u1 --- -# qiskit.pulse.builder.u1[¶](#qiskit-pulse-builder-u1 "Permalink to this headline") +# qiskit.pulse.builder.u1 -`u1(theta, qubit)` +`u1(theta, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `U1Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.u2.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.u2.md index 123656d25dd..5689e9208c3 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.u2.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.u2 --- -# qiskit.pulse.builder.u2[¶](#qiskit-pulse-builder-u2 "Permalink to this headline") +# qiskit.pulse.builder.u2 -`u2(phi, lam, qubit)` +`u2(phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `U2Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.u3.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.u3.md index 98a5e8b3835..edd35910dd0 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.u3.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.u3 --- -# qiskit.pulse.builder.u3[¶](#qiskit-pulse-builder-u3 "Permalink to this headline") +# qiskit.pulse.builder.u3 -`u3(theta, phi, lam, qubit)` +`u3(theta, phi, lam, qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `U3Gate` on the input physical qubit. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.builder.x.md b/docs/api/qiskit/0.41/qiskit.pulse.builder.x.md index c4aaadfc7e5..50e44d8ee87 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.builder.x.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.builder.x --- -# qiskit.pulse.builder.x[¶](#qiskit-pulse-builder-x "Permalink to this headline") +# qiskit.pulse.builder.x -`x(qubit)` +`x(qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/builder.py "view source code") Call a `XGate` on the input physical qubit. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.AcquireChannel.md b/docs/api/qiskit/0.41/qiskit.pulse.channels.AcquireChannel.md index 8c22c870ea1..9400a701fcc 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.AcquireChannel.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.AcquireChannel.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.channels.AcquireChannel --- -# AcquireChannel[¶](#acquirechannel "Permalink to this headline") +# AcquireChannel -`AcquireChannel(index)` +`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: [`qiskit.pulse.channels.Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.ControlChannel.md b/docs/api/qiskit/0.41/qiskit.pulse.channels.ControlChannel.md index ea21e86a570..cd5282bfb3f 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.ControlChannel.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.ControlChannel.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.channels.ControlChannel --- -# ControlChannel[¶](#controlchannel "Permalink to this headline") +# ControlChannel -`ControlChannel(index)` +`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.DriveChannel.md b/docs/api/qiskit/0.41/qiskit.pulse.channels.DriveChannel.md index 50c95f62cfc..84992f7a95f 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.DriveChannel.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.DriveChannel.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.channels.DriveChannel --- -# DriveChannel[¶](#drivechannel "Permalink to this headline") +# DriveChannel -`DriveChannel(index)` +`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.MeasureChannel.md b/docs/api/qiskit/0.41/qiskit.pulse.channels.MeasureChannel.md index e4835e3bac8..e936a32c145 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.MeasureChannel.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.MeasureChannel.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.channels.MeasureChannel --- -# MeasureChannel[¶](#measurechannel "Permalink to this headline") +# MeasureChannel -`MeasureChannel(index)` +`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.MemorySlot.md b/docs/api/qiskit/0.41/qiskit.pulse.channels.MemorySlot.md index f9c24aaffbd..db97a471ae8 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.MemorySlot.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.MemorySlot.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.channels.MemorySlot --- -# MemorySlot[¶](#memoryslot "Permalink to this headline") +# MemorySlot -`MemorySlot(index)` +`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.ClassicalIOChannel` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.RegisterSlot.md b/docs/api/qiskit/0.41/qiskit.pulse.channels.RegisterSlot.md index 1e2aa92e5ea..20a0d97ee87 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.RegisterSlot.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.RegisterSlot.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.channels.RegisterSlot --- -# RegisterSlot[¶](#registerslot "Permalink to this headline") +# RegisterSlot -`RegisterSlot(index)` +`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.ClassicalIOChannel` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.channels.SnapshotChannel.md b/docs/api/qiskit/0.41/qiskit.pulse.channels.SnapshotChannel.md index 0d7420cd655..45dfe1c0bec 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.channels.SnapshotChannel.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.channels.SnapshotChannel.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.channels.SnapshotChannel --- -# SnapshotChannel[¶](#snapshotchannel "Permalink to this headline") +# SnapshotChannel -`SnapshotChannel(*args, **kwargs)` +`SnapshotChannel(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.ClassicalIOChannel` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Acquire.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Acquire.md index bdec63c7319..2191c4ae4c0 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Acquire.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.instructions.Acquire --- -# Acquire[¶](#acquire "Permalink to this headline") +# Acquire -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/acquire.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -162,7 +162,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Acquire.is_parameterized()` +`Acquire.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/acquire.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Call.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Call.md index 3f6fc9d1dc3..d3685c1768c 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Call.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.instructions.Call --- -# Call[¶](#call "Permalink to this headline") +# Call -`Call(subroutine, value_dict=None, name=None)` +`Call(subroutine, value_dict=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/call.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -61,7 +61,7 @@ A new schedule with `schedule` a this instruction at t=0. -`Call.assigned_subroutine()` +`Call.assigned_subroutine()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/call.py "view source code") Returns this subroutine with the parameters assigned. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Delay.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Delay.md index 869389c778e..30778c63146 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Delay.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.instructions.Delay --- -# Delay[¶](#delay "Permalink to this headline") +# Delay -`Delay(duration, channel, name=None)` +`Delay(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/delay.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Play.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Play.md index c2760bc10ce..e81acb82b14 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Play.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.instructions.Play --- -# Play[¶](#play "Permalink to this headline") +# Play -`Play(pulse, channel, name=None)` +`Play(pulse, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/play.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Reference.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Reference.md index 709fa5aacac..e8b5e2d79b8 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Reference.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Reference.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.instructions.Reference --- -# Reference[¶](#reference "Permalink to this headline") +# Reference -`Reference(name, *extra_keys)` +`Reference(name, *extra_keys)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/reference.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.RelativeBarrier.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.RelativeBarrier.md index 9a16224184e..e8cbe6f7f77 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.RelativeBarrier.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.RelativeBarrier.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.instructions.RelativeBarrier --- -# RelativeBarrier[¶](#relativebarrier "Permalink to this headline") +# RelativeBarrier -`RelativeBarrier(*channels, name=None)` +`RelativeBarrier(*channels, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/directives.py "view source code") Bases: `qiskit.pulse.instructions.directives.Directive` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetFrequency.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetFrequency.md index a19229bb314..fc1bb6800f7 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetFrequency.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.instructions.SetFrequency --- -# SetFrequency[¶](#setfrequency "Permalink to this headline") +# SetFrequency -`SetFrequency(frequency, channel, name=None)` +`SetFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetPhase.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetPhase.md index b9fe4b50aba..afb67fae325 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.SetPhase.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.instructions.SetPhase --- -# SetPhase[¶](#setphase "Permalink to this headline") +# SetPhase -`SetPhase(phase, channel, name=None)` +`SetPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/phase.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftFrequency.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftFrequency.md index dff8464b2b1..45312883111 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftFrequency.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.instructions.ShiftFrequency --- -# ShiftFrequency[¶](#shiftfrequency "Permalink to this headline") +# ShiftFrequency -`ShiftFrequency(frequency, channel, name=None)` +`ShiftFrequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/frequency.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftPhase.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftPhase.md index a0955b5a318..d2346399342 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.ShiftPhase.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.instructions.ShiftPhase --- -# ShiftPhase[¶](#shiftphase "Permalink to this headline") +# ShiftPhase -`ShiftPhase(phase, channel, name=None)` +`ShiftPhase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/phase.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Snapshot.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Snapshot.md index c50ed745b18..9839824acd5 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.Snapshot.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.instructions.Snapshot --- -# Snapshot[¶](#snapshot "Permalink to this headline") +# Snapshot -`Snapshot(label, snapshot_type='statevector', name=None)` +`Snapshot(label, snapshot_type='statevector', name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/snapshot.py "view source code") Bases: [`qiskit.pulse.instructions.instruction.Instruction`](pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction") @@ -152,7 +152,7 @@ A new schedule with `schedule` inserted with this instruction at t=0. -`Snapshot.is_parameterized()` +`Snapshot.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/snapshot.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.instructions.TimeBlockade.md b/docs/api/qiskit/0.41/qiskit.pulse.instructions.TimeBlockade.md index 9dce8e9afd4..d166a83540b 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.instructions.TimeBlockade.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.instructions.TimeBlockade.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.instructions.TimeBlockade --- -# TimeBlockade[¶](#timeblockade "Permalink to this headline") +# TimeBlockade -`TimeBlockade(duration, channel, name=None)` +`TimeBlockade(duration, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/instructions/directives.py "view source code") Bases: `qiskit.pulse.instructions.directives.Directive` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.Constant.md b/docs/api/qiskit/0.41/qiskit.pulse.library.Constant.md index 0605262808f..29561260fa0 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.Constant.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.library.Constant --- -# Constant[¶](#constant "Permalink to this headline") +# Constant -`Constant(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` +`Constant(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.Drag.md b/docs/api/qiskit/0.41/qiskit.pulse.library.Drag.md index 45fb44a7ce9..a846113be97 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.Drag.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.library.Drag --- -# Drag[¶](#drag "Permalink to this headline") +# Drag -`Drag(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], beta: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` +`Drag(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], beta: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.Gaussian.md b/docs/api/qiskit/0.41/qiskit.pulse.library.Gaussian.md index bc768d01969..8a0f7d07ad4 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.Gaussian.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.library.Gaussian --- -# Gaussian[¶](#gaussian "Permalink to this headline") +# Gaussian -`Gaussian(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` +`Gaussian(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquare.md b/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquare.md index c5ade9d2115..4a1c157da9e 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquare.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.library.GaussianSquare --- -# GaussianSquare[¶](#gaussiansquare "Permalink to this headline") +# GaussianSquare -`GaussianSquare(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], width: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, risefall_sigma_ratio: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)` +`GaussianSquare(duration: Union[int, qiskit.circuit.parameterexpression.ParameterExpression], amp: Union[complex, float, qiskit.circuit.parameterexpression.ParameterExpression], sigma: Union[float, qiskit.circuit.parameterexpression.ParameterExpression], width: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, angle: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, risefall_sigma_ratio: Optional[Union[float, qiskit.circuit.parameterexpression.ParameterExpression]] = None, name: Optional[str] = None, limit_amplitude: Optional[bool] = None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquareDrag.md b/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquareDrag.md index 7a6c8777742..acbc560e389 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquareDrag.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.GaussianSquareDrag.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.library.GaussianSquareDrag --- -# qiskit.pulse.library.GaussianSquareDrag[¶](#qiskit-pulse-library-gaussiansquaredrag "Permalink to this headline") +# qiskit.pulse.library.GaussianSquareDrag -`GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)` +`GaussianSquareDrag(duration, amp, sigma, beta, width=None, angle=0.0, risefall_sigma_ratio=None, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") A square pulse with a Drag shaped rise and fall diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.ParametricPulse.md b/docs/api/qiskit/0.41/qiskit.pulse.library.ParametricPulse.md index 92c0da7a384..8a9d14e75ed 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.ParametricPulse.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.ParametricPulse.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.library.ParametricPulse --- -# ParametricPulse[¶](#parametricpulse "Permalink to this headline") +# ParametricPulse -`ParametricPulse(duration, name=None, limit_amplitude=None)` +`ParametricPulse(duration, name=None, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -72,7 +72,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`abstract ParametricPulse.get_waveform()` +`abstract ParametricPulse.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -84,7 +84,7 @@ Return a Waveform with samples filled according to the formula that the pulse re -`ParametricPulse.is_parameterized()` +`ParametricPulse.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") Return True iff the instruction is parameterized. @@ -96,7 +96,7 @@ Return True iff the instruction is parameterized. -`abstract ParametricPulse.validate_parameters()` +`abstract ParametricPulse.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/parametric_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.ScalableSymbolicPulse.md b/docs/api/qiskit/0.41/qiskit.pulse.library.ScalableSymbolicPulse.md index 90f112e61b0..f0070f1fa30 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.ScalableSymbolicPulse.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.ScalableSymbolicPulse.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.library.ScalableSymbolicPulse --- -# ScalableSymbolicPulse[¶](#scalablesymbolicpulse "Permalink to this headline") +# ScalableSymbolicPulse -`ScalableSymbolicPulse(pulse_type, duration, amp, angle, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` +`ScalableSymbolicPulse(pulse_type, duration, amp, angle, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: [`qiskit.pulse.library.symbolic_pulses.SymbolicPulse`](qiskit.pulse.library.SymbolicPulse "qiskit.pulse.library.symbolic_pulses.SymbolicPulse") diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.SymbolicPulse.md b/docs/api/qiskit/0.41/qiskit.pulse.library.SymbolicPulse.md index 2db05b92476..1addf8bc224 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.SymbolicPulse.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.SymbolicPulse.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.library.SymbolicPulse --- -# SymbolicPulse[¶](#symbolicpulse "Permalink to this headline") +# SymbolicPulse -`SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)` +`SymbolicPulse(pulse_type, duration, parameters=None, name=None, limit_amplitude=None, envelope=None, constraints=None, valid_amp_conditions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -159,7 +159,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`SymbolicPulse.get_waveform()` +`SymbolicPulse.get_waveform()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. @@ -186,7 +186,7 @@ A waveform representation of this pulse. -`SymbolicPulse.is_parameterized()` +`SymbolicPulse.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Return True iff the instruction is parameterized. @@ -198,7 +198,7 @@ Return True iff the instruction is parameterized. -`SymbolicPulse.validate_parameters()` +`SymbolicPulse.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/symbolic_pulses.py "view source code") Validate parameters. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.Waveform.md b/docs/api/qiskit/0.41/qiskit.pulse.library.Waveform.md index 75cd3ab8873..d2e2833ba34 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.Waveform.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.library.Waveform --- -# Waveform[¶](#waveform "Permalink to this headline") +# Waveform -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -69,7 +69,7 @@ Visualization output data. The returned data type depends on the `plotter`. If m -`Waveform.is_parameterized()` +`Waveform.is_parameterized()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/waveform.py "view source code") Return True iff the instruction is parameterized. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.cos.md b/docs/api/qiskit/0.41/qiskit.pulse.library.cos.md index 8caeb8db881..4f10e688a06 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.cos.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.cos.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.library.cos --- -# qiskit.pulse.library.cos[¶](#qiskit-pulse-library-cos "Permalink to this headline") +# qiskit.pulse.library.cos -`cos(duration, amp, freq=None, phase=0, name=None)` +`cos(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates cosine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.gaussian_deriv.md b/docs/api/qiskit/0.41/qiskit.pulse.library.gaussian_deriv.md index 1dae55202a6..d72fd09553d 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.gaussian_deriv.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.gaussian_deriv.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.library.gaussian_deriv --- -# qiskit.pulse.library.gaussian\_deriv[¶](#qiskit-pulse-library-gaussian-deriv "Permalink to this headline") +# qiskit.pulse.library.gaussian\_deriv -`gaussian_deriv(duration, amp, sigma, name=None)` +`gaussian_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.gaussian_square.md b/docs/api/qiskit/0.41/qiskit.pulse.library.gaussian_square.md index 4617fa90a09..9443df2c001 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.gaussian_square.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.gaussian_square.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.library.gaussian_square --- -# qiskit.pulse.library.gaussian\_square[¶](#qiskit-pulse-library-gaussian-square "Permalink to this headline") +# qiskit.pulse.library.gaussian\_square -`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)` +`gaussian_square(duration, amp, sigma, risefall=None, width=None, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates gaussian square [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). @@ -24,9 +24,9 @@ $$ \end{cases}\end{split} $$ -where $g(x)$ is the Gaussian function sampled from in [`gaussian()`](qiskit.pulse.library.gaussian "qiskit.pulse.library.gaussian") with $A=$ `amp`, $\mu=1$, and $\sigma=$ `sigma`. I.e. $f(x)$ represents a square pulse with smooth Gaussian edges. +where $g(x)$ is the Gaussian function sampled from in [`gaussian()`](qiskit.pulse.library.gaussian#qiskit.pulse.library.gaussian "qiskit.pulse.library.gaussian") with $A=$ `amp`, $\mu=1$, and $\sigma=$ `sigma`. I.e. $f(x)$ represents a square pulse with smooth Gaussian edges. -If `zero_ends == True`, the samples for the Gaussian ramps are remapped as in [`gaussian()`](qiskit.pulse.library.gaussian "qiskit.pulse.library.gaussian"). +If `zero_ends == True`, the samples for the Gaussian ramps are remapped as in [`gaussian()`](qiskit.pulse.library.gaussian#qiskit.pulse.library.gaussian "qiskit.pulse.library.gaussian"). **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.sawtooth.md b/docs/api/qiskit/0.41/qiskit.pulse.library.sawtooth.md index 73f285b56a9..76bbe6524e5 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.sawtooth.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.sawtooth.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.library.sawtooth --- -# qiskit.pulse.library.sawtooth[¶](#qiskit-pulse-library-sawtooth "Permalink to this headline") +# qiskit.pulse.library.sawtooth -`sawtooth(duration, amp, freq=None, phase=0, name=None)` +`sawtooth(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates sawtooth wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.sech.md b/docs/api/qiskit/0.41/qiskit.pulse.library.sech.md index d66fe85c27d..2bfc83e8347 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.sech.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.sech.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.library.sech --- -# qiskit.pulse.library.sech[¶](#qiskit-pulse-library-sech "Permalink to this headline") +# qiskit.pulse.library.sech -`sech(duration, amp, sigma, name=None, zero_ends=True)` +`sech(duration, amp, sigma, name=None, zero_ends=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.sech_deriv.md b/docs/api/qiskit/0.41/qiskit.pulse.library.sech_deriv.md index 9aa302a5d88..a1beed16e39 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.sech_deriv.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.sech_deriv.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.library.sech_deriv --- -# qiskit.pulse.library.sech\_deriv[¶](#qiskit-pulse-library-sech-deriv "Permalink to this headline") +# qiskit.pulse.library.sech\_deriv -`sech_deriv(duration, amp, sigma, name=None)` +`sech_deriv(duration, amp, sigma, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.sin.md b/docs/api/qiskit/0.41/qiskit.pulse.library.sin.md index 594fa91011b..20d23ba6db8 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.sin.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.sin.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.library.sin --- -# qiskit.pulse.library.sin[¶](#qiskit-pulse-library-sin "Permalink to this headline") +# qiskit.pulse.library.sin -`sin(duration, amp, freq=None, phase=0, name=None)` +`sin(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates sine wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.square.md b/docs/api/qiskit/0.41/qiskit.pulse.library.square.md index 06825d1f657..a94da2f4f97 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.square.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.square.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.library.square --- -# qiskit.pulse.library.square[¶](#qiskit-pulse-library-square "Permalink to this headline") +# qiskit.pulse.library.square -`square(duration, amp, freq=None, phase=0, name=None)` +`square(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates square wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.triangle.md b/docs/api/qiskit/0.41/qiskit.pulse.library.triangle.md index 5fa69c35418..e4c7cbf57ef 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.triangle.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.triangle.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.library.triangle --- -# qiskit.pulse.library.triangle[¶](#qiskit-pulse-library-triangle "Permalink to this headline") +# qiskit.pulse.library.triangle -`triangle(duration, amp, freq=None, phase=0, name=None)` +`triangle(duration, amp, freq=None, phase=0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates triangle wave [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.library.zero.md b/docs/api/qiskit/0.41/qiskit.pulse.library.zero.md index bc5c894eaa4..63ddb1835a4 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.library.zero.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.library.zero.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.library.zero --- -# qiskit.pulse.library.zero[¶](#qiskit-pulse-library-zero "Permalink to this headline") +# qiskit.pulse.library.zero -`zero(duration, name=None)` +`zero(duration, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/library/discrete.py "view source code") Generates zero-sampled [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignEquispaced.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignEquispaced.md index ad61ac2475b..ab37294e2c0 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignEquispaced.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignEquispaced.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.transforms.AlignEquispaced --- -# AlignEquispaced[¶](#alignequispaced "Permalink to this headline") +# AlignEquispaced -`AlignEquispaced(duration)` +`AlignEquispaced(duration)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -30,7 +30,7 @@ Create new equispaced context. -`AlignEquispaced.align(schedule)` +`AlignEquispaced.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -52,7 +52,7 @@ Schedule with reallocated instructions. -`AlignEquispaced.to_dict()` +`AlignEquispaced.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignFunc.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignFunc.md index e3ebef53667..3533b01d489 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignFunc.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignFunc.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.transforms.AlignFunc --- -# AlignFunc[¶](#alignfunc "Permalink to this headline") +# AlignFunc -`AlignFunc(duration, func)` +`AlignFunc(duration, func)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -44,7 +44,7 @@ Create new equispaced context. -`AlignFunc.align(schedule)` +`AlignFunc.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. @@ -66,7 +66,7 @@ Schedule with reallocated instructions. -`AlignFunc.to_dict()` +`AlignFunc.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Returns dictionary to represent this alignment. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignLeft.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignLeft.md index b71dce5ff62..95dc46fa569 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignLeft.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignLeft.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.transforms.AlignLeft --- -# AlignLeft[¶](#alignleft "Permalink to this headline") +# AlignLeft -`AlignLeft` +`AlignLeft`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new left-justified context. -`AlignLeft.align(schedule)` +`AlignLeft.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignRight.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignRight.md index 0b7aee6c43d..614bbd5203d 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignRight.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignRight.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.transforms.AlignRight --- -# AlignRight[¶](#alignright "Permalink to this headline") +# AlignRight -`AlignRight` +`AlignRight`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new right-justified context. -`AlignRight.align(schedule)` +`AlignRight.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignSequential.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignSequential.md index d952065145a..d126a129ee6 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignSequential.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.AlignSequential.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.pulse.transforms.AlignSequential --- -# AlignSequential[¶](#alignsequential "Permalink to this headline") +# AlignSequential -`AlignSequential` +`AlignSequential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Bases: [`qiskit.pulse.transforms.alignments.AlignmentKind`](pulse#qiskit.pulse.transforms.AlignmentKind "qiskit.pulse.transforms.alignments.AlignmentKind") @@ -26,7 +26,7 @@ Create new sequential context. -`AlignSequential.align(schedule)` +`AlignSequential.align(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/alignments.py "view source code") Reallocate instructions according to the policy. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.add_implicit_acquires.md index 79f84f646fe..93ac699254f 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.add_implicit_acquires.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.add_implicit_acquires.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.transforms.add_implicit_acquires --- -# qiskit.pulse.transforms.add\_implicit\_acquires[¶](#qiskit-pulse-transforms-add-implicit-acquires "Permalink to this headline") +# qiskit.pulse.transforms.add\_implicit\_acquires -`add_implicit_acquires(schedule, meas_map)` +`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.align_measures.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.align_measures.md index 9ebfdc15428..ecb1edc1670 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.align_measures.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.align_measures.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.transforms.align_measures --- -# qiskit.pulse.transforms.align\_measures[¶](#qiskit-pulse-transforms-align-measures "Permalink to this headline") +# qiskit.pulse.transforms.align\_measures -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.block_to_dag.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.block_to_dag.md index c7829932ce1..31b1e46df66 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.block_to_dag.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.block_to_dag.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.transforms.block_to_dag --- -# qiskit.pulse.transforms.block\_to\_dag[¶](#qiskit-pulse-transforms-block-to-dag "Permalink to this headline") +# qiskit.pulse.transforms.block\_to\_dag -`block_to_dag(block)` +`block_to_dag(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/dag.py "view source code") Convert schedule block instruction into DAG. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.block_to_schedule.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.block_to_schedule.md index f862b3a5960..7e27aedcf7b 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.block_to_schedule.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.block_to_schedule.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.transforms.block_to_schedule --- -# qiskit.pulse.transforms.block\_to\_schedule[¶](#qiskit-pulse-transforms-block-to-schedule "Permalink to this headline") +# qiskit.pulse.transforms.block\_to\_schedule -`block_to_schedule(block)` +`block_to_schedule(block)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Convert `ScheduleBlock` to `Schedule`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.compress_pulses.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.compress_pulses.md index 24060d44ea1..df3c3645df8 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.compress_pulses.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.compress_pulses.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.transforms.compress_pulses --- -# qiskit.pulse.transforms.compress\_pulses[¶](#qiskit-pulse-transforms-compress-pulses "Permalink to this headline") +# qiskit.pulse.transforms.compress\_pulses -`compress_pulses(schedules)` +`compress_pulses(schedules)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Optimization pass to replace identical pulses. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.flatten.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.flatten.md index 6106f13106d..26a4ecd06e3 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.flatten.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.flatten.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.transforms.flatten --- -# qiskit.pulse.transforms.flatten[¶](#qiskit-pulse-transforms-flatten "Permalink to this headline") +# qiskit.pulse.transforms.flatten -`flatten(program)` +`flatten(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Flatten (inline) any called nodes into a Schedule tree with no nested children. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.inline_subroutines.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.inline_subroutines.md index a7f39d3746b..49a462a6d7e 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.inline_subroutines.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.inline_subroutines.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.transforms.inline_subroutines --- -# qiskit.pulse.transforms.inline\_subroutines[¶](#qiskit-pulse-transforms-inline-subroutines "Permalink to this headline") +# qiskit.pulse.transforms.inline\_subroutines -`inline_subroutines(program)` +`inline_subroutines(program)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Recursively remove call instructions and inline the respective subroutine instructions. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.pad.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.pad.md index 46cc972cdb7..2646f0c9e5c 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.pad.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.transforms.pad --- -# qiskit.pulse.transforms.pad[¶](#qiskit-pulse-transforms-pad "Permalink to this headline") +# qiskit.pulse.transforms.pad -`pad(schedule, channels=None, until=None, inplace=False, pad_with=None)` +`pad(schedule, channels=None, until=None, inplace=False, pad_with=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.remove_directives.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.remove_directives.md index a9fca9a97c5..abba51e324b 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.remove_directives.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.remove_directives.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.transforms.remove_directives --- -# qiskit.pulse.transforms.remove\_directives[¶](#qiskit-pulse-transforms-remove-directives "Permalink to this headline") +# qiskit.pulse.transforms.remove\_directives -`remove_directives(schedule)` +`remove_directives(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Remove directives. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.remove_trivial_barriers.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.remove_trivial_barriers.md index 4c1f28435bb..cd17656eac0 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.remove_trivial_barriers.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.remove_trivial_barriers.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.transforms.remove_trivial_barriers --- -# qiskit.pulse.transforms.remove\_trivial\_barriers[¶](#qiskit-pulse-transforms-remove-trivial-barriers "Permalink to this headline") +# qiskit.pulse.transforms.remove\_trivial\_barriers -`remove_trivial_barriers(schedule)` +`remove_trivial_barriers(schedule)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/canonicalization.py "view source code") Remove trivial barriers with 0 or 1 channels. diff --git a/docs/api/qiskit/0.41/qiskit.pulse.transforms.target_qobj_transform.md b/docs/api/qiskit/0.41/qiskit.pulse.transforms.target_qobj_transform.md index 6426cd99d61..f884d7f88df 100644 --- a/docs/api/qiskit/0.41/qiskit.pulse.transforms.target_qobj_transform.md +++ b/docs/api/qiskit/0.41/qiskit.pulse.transforms.target_qobj_transform.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.pulse.transforms.target_qobj_transform --- -# qiskit.pulse.transforms.target\_qobj\_transform[¶](#qiskit-pulse-transforms-target-qobj-transform "Permalink to this headline") +# qiskit.pulse.transforms.target\_qobj\_transform -`target_qobj_transform(sched, remove_directives=True)` +`target_qobj_transform(sched, remove_directives=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/pulse/transforms/base_transforms.py "view source code") A basic pulse program transformation for OpenPulse API execution. diff --git a/docs/api/qiskit/0.41/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.41/qiskit.qasm.OpenQASMLexer.md index 75b078b35a3..a2f320e3d57 100644 --- a/docs/api/qiskit/0.41/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.41/qiskit.qasm.OpenQASMLexer.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qasm.OpenQASMLexer --- -# OpenQASMLexer[¶](#openqasmlexer "Permalink to this headline") +# OpenQASMLexer -`OpenQASMLexer(*args, **kwds)` +`OpenQASMLexer(*args, **kwds)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.lexer.RegexLexer` diff --git a/docs/api/qiskit/0.41/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.41/qiskit.qasm.Qasm.md index 4c9465f28a6..8b967c56cbc 100644 --- a/docs/api/qiskit/0.41/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.41/qiskit.qasm.Qasm.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qasm.Qasm --- -# Qasm[¶](#qasm "Permalink to this headline") +# Qasm -`Qasm(filename=None, data=None)` +`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ Create an OPENQASM circuit object. -`Qasm.generate_tokens()` +`Qasm.generate_tokens()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") Returns a generator of the tokens. @@ -32,7 +32,7 @@ Returns a generator of the tokens. -`Qasm.parse()` +`Qasm.parse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") Parse the data. @@ -40,7 +40,7 @@ Parse the data. -`Qasm.return_filename()` +`Qasm.return_filename()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/qasm.py "view source code") Return the filename. diff --git a/docs/api/qiskit/0.41/qiskit.qasm.QasmError.md b/docs/api/qiskit/0.41/qiskit.qasm.QasmError.md index 938da822a98..f46e5034371 100644 --- a/docs/api/qiskit/0.41/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.41/qiskit.qasm.QasmError.md @@ -6,11 +6,11 @@ python_api_type: exception python_api_name: qiskit.qasm.QasmError --- -# qiskit.qasm.QasmError[¶](#qiskit-qasm-qasmerror "Permalink to this headline") +# qiskit.qasm.QasmError -`QasmError(*msg)` +`QasmError(*msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/exceptions.py "view source code") Base class for errors raised while parsing OPENQASM. diff --git a/docs/api/qiskit/0.41/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.41/qiskit.qasm.QasmHTMLStyle.md index 55f8e61d8e1..cc32e462605 100644 --- a/docs/api/qiskit/0.41/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.41/qiskit.qasm.QasmHTMLStyle.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qasm.QasmHTMLStyle --- -# QasmHTMLStyle[¶](#qasmhtmlstyle "Permalink to this headline") +# QasmHTMLStyle -`QasmHTMLStyle` +`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.41/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.41/qiskit.qasm.QasmTerminalStyle.md index 31a08ac6c84..3f3f9758f93 100644 --- a/docs/api/qiskit/0.41/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.41/qiskit.qasm.QasmTerminalStyle.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qasm.QasmTerminalStyle --- -# QasmTerminalStyle[¶](#qasmterminalstyle "Permalink to this headline") +# QasmTerminalStyle -`QasmTerminalStyle` +`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` diff --git a/docs/api/qiskit/0.41/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.41/qiskit.qobj.GateCalibration.md index 9ded9d95a81..589e7c5f277 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.GateCalibration.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qobj.GateCalibration --- -# GateCalibration[¶](#gatecalibration "Permalink to this headline") +# GateCalibration -`GateCalibration(name, qubits, params, instructions)` +`GateCalibration(name, qubits, params, instructions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Initialize a single gate calibration. Instructions may reference waveforms which -`classmethod GateCalibration.from_dict(data)` +`classmethod GateCalibration.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -51,7 +51,7 @@ The GateCalibration from the input dictionary. -`GateCalibration.to_dict()` +`GateCalibration.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Gate Calibration. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.41/qiskit.qobj.PulseLibraryItem.md index 93649f18714..2f24a336726 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.PulseLibraryItem.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qobj.PulseLibraryItem --- -# PulseLibraryItem[¶](#pulselibraryitem "Permalink to this headline") +# PulseLibraryItem -`PulseLibraryItem(name, samples)` +`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a pulse library item. -`classmethod PulseLibraryItem.from_dict(data)` +`classmethod PulseLibraryItem.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseLibraryItem object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`PulseLibraryItem.to_dict()` +`PulseLibraryItem.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the pulse library item. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobj.md index 79c05a5451e..11d6ef7a31b 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobj.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qobj.PulseQobj --- -# PulseQobj[¶](#pulseqobj "Permalink to this headline") +# PulseQobj -`PulseQobj(qobj_id, config, experiments, header=None)` +`PulseQobj(qobj_id, config, experiments, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each Pulse Qobj object is used to represent a single payload that will be passed -`classmethod PulseQobj.from_dict(data)` +`classmethod PulseQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobj object from a dictionary. @@ -53,7 +53,7 @@ The PulseQobj from the input dictionary. -`PulseQobj.to_dict()` +`PulseQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjConfig.md index 85aa3a7facc..d2cf0167942 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjConfig.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qobj.PulseQobjConfig --- -# PulseQobjConfig[¶](#pulseqobjconfig "Permalink to this headline") +# PulseQobjConfig -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -40,7 +40,7 @@ Instantiate a PulseQobjConfig object. -`classmethod PulseQobjConfig.from_dict(data)` +`classmethod PulseQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjConfig object from a dictionary. @@ -60,7 +60,7 @@ The object from the input dictionary. -`PulseQobjConfig.to_dict()` +`PulseQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Pulse Qobj config. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperiment.md index ce32faa0b59..8c903a06dea 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperiment.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qobj.PulseQobjExperiment --- -# PulseQobjExperiment[¶](#pulseqobjexperiment "Permalink to this headline") +# PulseQobjExperiment -`PulseQobjExperiment(instructions, config=None, header=None)` +`PulseQobjExperiment(instructions, config=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a PulseQobjExperiment. -`classmethod PulseQobjExperiment.from_dict(data)` +`classmethod PulseQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`PulseQobjExperiment.to_dict()` +`PulseQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperimentConfig.md index 61a2e2cafb9..c5fbe60c869 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjExperimentConfig.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qobj.PulseQobjExperimentConfig --- -# PulseQobjExperimentConfig[¶](#pulseqobjexperimentconfig "Permalink to this headline") +# PulseQobjExperimentConfig -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjInstruction.md index 5bfe5131296..b04251e571f 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.PulseQobjInstruction.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qobj.PulseQobjInstruction --- -# PulseQobjInstruction[¶](#pulseqobjinstruction "Permalink to this headline") +# PulseQobjInstruction -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -44,7 +44,7 @@ Instantiate a new PulseQobjInstruction object. -`classmethod PulseQobjInstruction.from_dict(data)` +`classmethod PulseQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new PulseQobjExperimentConfig object from a dictionary. @@ -64,7 +64,7 @@ The object from the input dictionary. -`PulseQobjInstruction.to_dict()` +`PulseQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.41/qiskit.qobj.QasmExperimentCalibrations.md index 00052a02bbe..d86cb15111f 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.QasmExperimentCalibrations.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qobj.QasmExperimentCalibrations --- -# QasmExperimentCalibrations[¶](#qasmexperimentcalibrations "Permalink to this headline") +# QasmExperimentCalibrations -`QasmExperimentCalibrations(gates)` +`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ Initialize a container for calibrations. -`classmethod QasmExperimentCalibrations.from_dict(data)` +`classmethod QasmExperimentCalibrations.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new GateCalibration object from a dictionary. @@ -48,7 +48,7 @@ The QasmExperimentCalibrations from the input dictionary. -`QasmExperimentCalibrations.to_dict()` +`QasmExperimentCalibrations.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the calibrations. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobj.md index 10fcc3d36d3..99ccd488add 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobj.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qobj.QasmQobj --- -# QasmQobj[¶](#qasmqobj "Permalink to this headline") +# QasmQobj -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -33,7 +33,7 @@ Each QASM Qobj object is used to represent a single payload that will be passed -`classmethod QasmQobj.from_dict(data)` +`classmethod QasmQobj.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QASMQobj object from a dictionary. @@ -53,7 +53,7 @@ The QasmQobj from the input dictionary. -`QasmQobj.to_dict()` +`QasmQobj.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjConfig.md index 18d93bfca6b..3e51cfeecc5 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjConfig.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qobj.QasmQobjConfig --- -# QasmQobjConfig[¶](#qasmqobjconfig "Permalink to this headline") +# QasmQobjConfig -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `types.SimpleNamespace` @@ -42,7 +42,7 @@ Model for RunConfig. -`classmethod QasmQobjConfig.from_dict(data)` +`classmethod QasmQobjConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjConfig object from a dictionary. @@ -62,7 +62,7 @@ The object from the input dictionary. -`QasmQobjConfig.to_dict()` +`QasmQobjConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj config. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperiment.md index 652a0e7729c..7c26e8cd34b 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperiment.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qobj.QasmQobjExperiment --- -# QasmQobjExperiment[¶](#qasmqobjexperiment "Permalink to this headline") +# QasmQobjExperiment -`QasmQobjExperiment(config=None, header=None, instructions=None)` +`QasmQobjExperiment(config=None, header=None, instructions=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ Instantiate a QasmQobjExperiment. -`classmethod QasmQobjExperiment.from_dict(data)` +`classmethod QasmQobjExperiment.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjExperiment object from a dictionary. @@ -52,7 +52,7 @@ The object from the input dictionary. -`QasmQobjExperiment.to_dict()` +`QasmQobjExperiment.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Experiment. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperimentConfig.md index 42bce4f250c..3c0e32aab9f 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjExperimentConfig.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qobj.QasmQobjExperimentConfig --- -# QasmQobjExperimentConfig[¶](#qasmqobjexperimentconfig "Permalink to this headline") +# QasmQobjExperimentConfig -`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` +`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -29,7 +29,7 @@ Configuration for a single QASM experiment in the qobj. -`classmethod QasmQobjExperimentConfig.from_dict(data)` +`classmethod QasmQobjExperimentConfig.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QobjHeader object from a dictionary. @@ -49,7 +49,7 @@ QobjDictFieldr -`QasmQobjExperimentConfig.to_dict()` +`QasmQobjExperimentConfig.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the QASM Qobj. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjInstruction.md index 10788983b98..ed61b696cc7 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.QasmQobjInstruction.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qobj.QasmQobjInstruction --- -# QasmQobjInstruction[¶](#qasmqobjinstruction "Permalink to this headline") +# QasmQobjInstruction -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Instantiate a new QasmQobjInstruction object. -`classmethod QasmQobjInstruction.from_dict(data)` +`classmethod QasmQobjInstruction.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Create a new QasmQobjInstruction object from a dictionary. @@ -59,7 +59,7 @@ The object from the input dictionary. -`QasmQobjInstruction.to_dict()` +`QasmQobjInstruction.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/qasm_qobj.py "view source code") Return a dictionary format representation of the Instruction. diff --git a/docs/api/qiskit/0.41/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.41/qiskit.qobj.Qobj.md index c6aa4e0e496..3d0ab5f74d3 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.Qobj.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qobj.Qobj --- -# Qobj[¶](#qobj "Permalink to this headline") +# Qobj -`Qobj(qobj_id=None, config=None, experiments=None, header=None)` +`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/__init__.py "view source code") Bases: [`qiskit.qobj.qasm_qobj.QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.qasm_qobj.QasmQobj") diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.41/qiskit.qobj.QobjExperimentHeader.md index b220a9448c8..798b1649b61 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.QobjExperimentHeader.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qobj.QobjExperimentHeader --- -# QobjExperimentHeader[¶](#qobjexperimentheader "Permalink to this headline") +# QobjExperimentHeader -`QobjExperimentHeader(**kwargs)` +`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/common.py "view source code") Bases: [`qiskit.qobj.common.QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.common.QobjHeader") diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.41/qiskit.qobj.QobjHeader.md index 3057547c9b1..4004a4d4b68 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.QobjHeader.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qobj.QobjHeader --- -# QobjHeader[¶](#qobjheader "Permalink to this headline") +# QobjHeader -`QobjHeader(**kwargs)` +`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` diff --git a/docs/api/qiskit/0.41/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.41/qiskit.qobj.QobjMeasurementOption.md index 71c17d81048..7d0288e4291 100644 --- a/docs/api/qiskit/0.41/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.41/qiskit.qobj.QobjMeasurementOption.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.qobj.QobjMeasurementOption --- -# QobjMeasurementOption[¶](#qobjmeasurementoption "Permalink to this headline") +# QobjMeasurementOption -`QobjMeasurementOption(name, params=None)` +`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Instantiate a new QobjMeasurementOption object. -`classmethod QobjMeasurementOption.from_dict(data)` +`classmethod QobjMeasurementOption.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Create a new QobjMeasurementOption object from a dictionary. @@ -49,7 +49,7 @@ The object from the input dictionary. -`QobjMeasurementOption.to_dict()` +`QobjMeasurementOption.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qobj/pulse_qobj.py "view source code") Return a dict format representation of the QobjMeasurementOption. diff --git a/docs/api/qiskit/0.41/qiskit.qpy.dump.md b/docs/api/qiskit/0.41/qiskit.qpy.dump.md index a35b4775ad2..fe1c9056406 100644 --- a/docs/api/qiskit/0.41/qiskit.qpy.dump.md +++ b/docs/api/qiskit/0.41/qiskit.qpy.dump.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.qpy.dump --- -# qiskit.qpy.dump[¶](#qiskit-qpy-dump "Permalink to this headline") +# qiskit.qpy.dump -`dump(programs, file_obj, metadata_serializer=None)` +`dump(programs, file_obj, metadata_serializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qpy/interface.py "view source code") Write QPY binary data to a file diff --git a/docs/api/qiskit/0.41/qiskit.qpy.load.md b/docs/api/qiskit/0.41/qiskit.qpy.load.md index 178f7e051b6..7df78086f70 100644 --- a/docs/api/qiskit/0.41/qiskit.qpy.load.md +++ b/docs/api/qiskit/0.41/qiskit.qpy.load.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.qpy.load --- -# qiskit.qpy.load[¶](#qiskit-qpy-load "Permalink to this headline") +# qiskit.qpy.load -`load(file_obj, metadata_deserializer=None)` +`load(file_obj, metadata_deserializer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/qpy/interface.py "view source code") Load a QPY binary file diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.CNOTDihedral.md b/docs/api/qiskit/0.41/qiskit.quantum_info.CNOTDihedral.md index 4fea4917196..de95a709d7a 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.CNOTDihedral.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.CNOTDihedral --- -# CNOTDihedral[¶](#cnotdihedral "Permalink to this headline") +# CNOTDihedral -`CNOTDihedral(data=None, num_qubits=None, validate=True)` +`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -79,7 +79,7 @@ Initialize a CNOTDihedral operator object. -`CNOTDihedral.adjoint()` +`CNOTDihedral.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the adjoint of the Operator. @@ -87,7 +87,7 @@ Return the adjoint of the Operator. -`CNOTDihedral.compose(other, qargs=None, front=False)` +`CNOTDihedral.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the operator composition with another CNOTDihedral. @@ -119,7 +119,7 @@ The composed CNOTDihedral. -`CNOTDihedral.conjugate()` +`CNOTDihedral.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the conjugate of the CNOTDihedral. @@ -160,7 +160,7 @@ The right matrix multiplied Operator. -`CNOTDihedral.expand(other)` +`CNOTDihedral.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the reverse-order tensor product with another CNOTDihedral. @@ -248,7 +248,7 @@ BaseOperator -`CNOTDihedral.tensor(other)` +`CNOTDihedral.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the tensor product with another CNOTDihedral. @@ -274,7 +274,7 @@ is the current CNOTDihedral, and $b$ is the other CNOTDihedral. -`CNOTDihedral.to_circuit()` +`CNOTDihedral.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a QuantumCircuit implementing the CNOT-Dihedral element. @@ -295,7 +295,7 @@ a circuit implementation of the CNOTDihedral object. -`CNOTDihedral.to_instruction()` +`CNOTDihedral.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return a Gate instruction implementing the CNOTDihedral object. @@ -303,7 +303,7 @@ Return a Gate instruction implementing the CNOTDihedral object. -`CNOTDihedral.to_matrix()` +`CNOTDihedral.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert operator to Numpy matrix. @@ -311,7 +311,7 @@ Convert operator to Numpy matrix. -`CNOTDihedral.to_operator()` +`CNOTDihedral.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Convert to an Operator object. @@ -319,7 +319,7 @@ Convert to an Operator object. -`CNOTDihedral.transpose()` +`CNOTDihedral.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/dihedral.py "view source code") Return the transpose of the CNOTDihedral. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Chi.md b/docs/api/qiskit/0.41/qiskit.quantum_info.Chi.md index 0ed98223231..36d4acdca4c 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Chi.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.Chi --- -# Chi[¶](#chi "Permalink to this headline") +# Chi -`Chi(data, input_dims=None, output_dims=None)` +`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`Chi.adjoint()` +`Chi.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`Chi.compose(other, qargs=None, front=False)` +`Chi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the operator composition with another Chi. @@ -96,7 +96,7 @@ The composed Chi. -`Chi.conjugate()` +`Chi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`Chi.expand(other)` +`Chi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the reverse-order tensor product with another Chi. @@ -265,7 +265,7 @@ BaseOperator -`Chi.tensor(other)` +`Chi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the tensor product with another Chi. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`Chi.transpose()` +`Chi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/chi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Choi.md b/docs/api/qiskit/0.41/qiskit.quantum_info.Choi.md index 19574eaf6bb..8ff0484a512 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Choi.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.Choi --- -# Choi[¶](#choi "Permalink to this headline") +# Choi -`Choi(data, input_dims=None, output_dims=None)` +`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`Choi.compose(other, qargs=None, front=False)` +`Choi.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the operator composition with another Choi. @@ -104,7 +104,7 @@ The composed Choi. -`Choi.conjugate()` +`Choi.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the conjugate quantum channel. @@ -149,7 +149,7 @@ The right matrix multiplied Operator. -`Choi.expand(other)` +`Choi.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the reverse-order tensor product with another Choi. @@ -273,7 +273,7 @@ BaseOperator -`Choi.tensor(other)` +`Choi.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the tensor product with another Choi. @@ -329,7 +329,7 @@ Try to convert channel to a unitary representation Operator. -`Choi.transpose()` +`Choi.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/choi.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Clifford.md b/docs/api/qiskit/0.41/qiskit.quantum_info.Clifford.md index c736918f797..668c70ed888 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Clifford.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.Clifford --- -# Clifford[¶](#clifford "Permalink to this headline") +# Clifford -`Clifford(data, validate=True, copy=True)` +`Clifford(data, validate=True, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin`, [`qiskit.circuit.operation.Operation`](qiskit.circuit.Operation "qiskit.circuit.operation.Operation") @@ -75,7 +75,7 @@ Initialize an operator object. -`Clifford.adjoint()` +`Clifford.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the adjoint of the Operator. @@ -83,7 +83,7 @@ Return the adjoint of the Operator. -`Clifford.compose(other, qargs=None, front=False)` +`Clifford.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the operator composition with another Clifford. @@ -115,7 +115,7 @@ The composed Clifford. -`Clifford.conjugate()` +`Clifford.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the conjugate of the Clifford. @@ -123,7 +123,7 @@ Return the conjugate of the Clifford. -`Clifford.copy()` +`Clifford.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Make a deep copy of current operator. @@ -156,7 +156,7 @@ The right matrix multiplied Operator. -`Clifford.expand(other)` +`Clifford.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the reverse-order tensor product with another Clifford. @@ -178,7 +178,7 @@ is the current Clifford, and $b$ is the other Clifford. -`static Clifford.from_circuit(circuit)` +`static Clifford.from_circuit(circuit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Initialize from a QuantumCircuit or Instruction. @@ -202,7 +202,7 @@ the Clifford object for the instruction. -`classmethod Clifford.from_dict(obj)` +`classmethod Clifford.from_dict(obj)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Load a Clifford from a dictionary @@ -210,7 +210,7 @@ Load a Clifford from a dictionary -`static Clifford.from_label(label)` +`static Clifford.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a tensor product of single-qubit Clifford gates. @@ -268,7 +268,7 @@ Return tuple of input dimension for specified subsystems. -`Clifford.is_unitary()` +`Clifford.is_unitary()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return True if the Clifford table is valid. @@ -334,7 +334,7 @@ BaseOperator -`Clifford.tensor(other)` +`Clifford.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the tensor product with another Clifford. @@ -360,7 +360,7 @@ is the current Clifford, and $b$ is the other Clifford. -`Clifford.to_circuit()` +`Clifford.to_circuit()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a QuantumCircuit implementing the Clifford. @@ -383,7 +383,7 @@ a circuit implementation of the Clifford. -`Clifford.to_dict()` +`Clifford.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return dictionary representation of Clifford object. @@ -391,7 +391,7 @@ Return dictionary representation of Clifford object. -`Clifford.to_instruction()` +`Clifford.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return a Gate instruction implementing the Clifford. @@ -399,7 +399,7 @@ Return a Gate instruction implementing the Clifford. -`Clifford.to_labels(array=False, mode='B')` +`Clifford.to_labels(array=False, mode='B')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert a Clifford to a list Pauli (de)stabilizer string labels. @@ -437,7 +437,7 @@ list or array -`Clifford.to_matrix()` +`Clifford.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert operator to Numpy matrix. @@ -445,7 +445,7 @@ Convert operator to Numpy matrix. -`Clifford.to_operator()` +`Clifford.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Convert to an Operator object. @@ -453,7 +453,7 @@ Convert to an Operator object. -`Clifford.transpose()` +`Clifford.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/clifford.py "view source code") Return the transpose of the Clifford. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.DensityMatrix.md b/docs/api/qiskit/0.41/qiskit.quantum_info.DensityMatrix.md index 416d684fd85..212fba44a41 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.DensityMatrix.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.DensityMatrix --- -# DensityMatrix[¶](#densitymatrix "Permalink to this headline") +# DensityMatrix -`DensityMatrix(data, dims=None)` +`DensityMatrix(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`DensityMatrix.conjugate()` +`DensityMatrix.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the conjugate of the density matrix. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`DensityMatrix.draw(output=None, **drawer_args)` +`DensityMatrix.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a visualization of the Statevector. @@ -99,7 +99,7 @@ Return a visualization of the Statevector. -`DensityMatrix.evolve(other, qargs=None)` +`DensityMatrix.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Evolve a quantum state by an operator. @@ -124,7 +124,7 @@ QuantumState -`DensityMatrix.expand(other)` +`DensityMatrix.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state other ⊗ self. @@ -148,7 +148,7 @@ the tensor product state other ⊗ self. -`DensityMatrix.expectation_value(oper, qargs=None)` +`DensityMatrix.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Compute the expectation value of an operator. @@ -169,7 +169,7 @@ complex -`classmethod DensityMatrix.from_instruction(instruction)` +`classmethod DensityMatrix.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the output density matrix of an instruction. @@ -195,7 +195,7 @@ the final density matrix. -`static DensityMatrix.from_int(i, dims)` +`static DensityMatrix.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a computational basis state density matrix. @@ -223,7 +223,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod DensityMatrix.from_label(label)` +`classmethod DensityMatrix.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -256,7 +256,7 @@ The N-qubit basis state density matrix. -`DensityMatrix.is_valid(atol=None, rtol=None)` +`DensityMatrix.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return True if trace 1 and positive semidefinite. @@ -288,7 +288,7 @@ tuple -`DensityMatrix.probabilities(qargs=None, decimals=None)` +`DensityMatrix.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the subsystem measurement probability vector. @@ -386,7 +386,7 @@ dict -`DensityMatrix.purity()` +`DensityMatrix.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the purity of the quantum state. @@ -394,7 +394,7 @@ Return the purity of the quantum state. -`DensityMatrix.reset(qargs=None)` +`DensityMatrix.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Reset state or subsystems to the 0-state. @@ -418,7 +418,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`DensityMatrix.reverse_qargs()` +`DensityMatrix.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a DensityMatrix with reversed subsystem ordering. @@ -498,7 +498,7 @@ Set the seed for the quantum state RNG. -`DensityMatrix.tensor(other)` +`DensityMatrix.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the tensor product state self ⊗ other. @@ -522,7 +522,7 @@ the tensor product operator self ⊗ other. -`DensityMatrix.to_dict(decimals=None)` +`DensityMatrix.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert the density matrix to dictionary form. @@ -600,7 +600,7 @@ print(rho.to_dict()) -`DensityMatrix.to_operator()` +`DensityMatrix.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Convert to Operator @@ -608,7 +608,7 @@ Convert to Operator -`DensityMatrix.to_statevector(atol=None, rtol=None)` +`DensityMatrix.to_statevector(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return a statevector from a pure density matrix. @@ -635,7 +635,7 @@ Corresponds to the eigenvector of the only non-zero eigenvalue. -`DensityMatrix.trace()` +`DensityMatrix.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/densitymatrix.py "view source code") Return the trace of the density matrix. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Kraus.md b/docs/api/qiskit/0.41/qiskit.quantum_info.Kraus.md index 37688ec2da9..4de5d303ea0 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Kraus.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.Kraus --- -# Kraus[¶](#kraus "Permalink to this headline") +# Kraus -`Kraus(data, input_dims=None, output_dims=None)` +`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -56,7 +56,7 @@ If the input or output dimensions are None, they will be automatically determine -`Kraus.adjoint()` +`Kraus.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the adjoint quantum channel. @@ -68,7 +68,7 @@ Return the adjoint quantum channel. -`Kraus.compose(other, qargs=None, front=False)` +`Kraus.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the operator composition with another Kraus. @@ -100,7 +100,7 @@ The composed Kraus. -`Kraus.conjugate()` +`Kraus.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the conjugate quantum channel. @@ -145,7 +145,7 @@ The right matrix multiplied Operator. -`Kraus.expand(other)` +`Kraus.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the reverse-order tensor product with another Kraus. @@ -183,7 +183,7 @@ Test if Choi-matrix is completely-positive (CP) -`Kraus.is_cptp(atol=None, rtol=None)` +`Kraus.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return True if completely-positive trace-preserving. @@ -269,7 +269,7 @@ BaseOperator -`Kraus.tensor(other)` +`Kraus.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the tensor product with another Kraus. @@ -325,7 +325,7 @@ Try to convert channel to a unitary representation Operator. -`Kraus.transpose()` +`Kraus.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/kraus.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.OneQubitEulerDecomposer.md b/docs/api/qiskit/0.41/qiskit.quantum_info.OneQubitEulerDecomposer.md index ec42ded7f81..3abf9fd282e 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer --- -# OneQubitEulerDecomposer[¶](#onequbiteulerdecomposer "Permalink to this headline") +# OneQubitEulerDecomposer -`OneQubitEulerDecomposer(basis='U3', use_dag=False)` +`OneQubitEulerDecomposer(basis='U3', use_dag=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Bases: `object` @@ -52,7 +52,7 @@ Supported bases are: ‘U’, ‘PSX’, ‘ZSXX’, ‘ZSX’, ‘U321’, ‘U -`OneQubitEulerDecomposer.angles(unitary)` +`OneQubitEulerDecomposer.angles(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles for input array. @@ -72,7 +72,7 @@ tuple -`OneQubitEulerDecomposer.angles_and_phase(unitary)` +`OneQubitEulerDecomposer.angles_and_phase(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the Euler angles and phase for input array. @@ -92,7 +92,7 @@ tuple -`OneQubitEulerDecomposer.build_circuit(gates, global_phase)` +`OneQubitEulerDecomposer.build_circuit(gates, global_phase)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/one_qubit_decompose.py "view source code") Return the circuit or dag object from a list of gates. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Operator.md b/docs/api/qiskit/0.41/qiskit.quantum_info.Operator.md index b081a749639..2206cf56c8b 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Operator.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.Operator --- -# Operator[¶](#operator "Permalink to this headline") +# Operator -`Operator(data, input_dims=None, output_dims=None)` +`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -58,7 +58,7 @@ Return the adjoint of the Operator. -`Operator.compose(other, qargs=None, front=False)` +`Operator.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the operator composition with another Operator. @@ -90,7 +90,7 @@ The composed Operator. -`Operator.conjugate()` +`Operator.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the conjugate of the Operator. @@ -131,7 +131,7 @@ The right matrix multiplied Operator. -`Operator.equiv(other, rtol=None, atol=None)` +`Operator.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return True if operators are equivalent up to global phase. @@ -153,7 +153,7 @@ bool -`Operator.expand(other)` +`Operator.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the reverse-order tensor product with another Operator. @@ -175,7 +175,7 @@ is the current Operator, and $b$ is the other Operator. -`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None, final_layout=None)` +`classmethod Operator.from_circuit(circuit, ignore_set_layout=False, layout=None, final_layout=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Create a new Operator object from a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") @@ -202,7 +202,7 @@ An operator representing the input circuit -`classmethod Operator.from_label(label)` +`classmethod Operator.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return a tensor product of single-qubit operators. @@ -238,7 +238,7 @@ Return tuple of input dimension for specified subsystems. -`Operator.is_unitary(atol=None, rtol=None)` +`Operator.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return True if operator is a unitary matrix. @@ -254,7 +254,7 @@ Return tuple of output dimension for specified subsystems. -`Operator.power(n)` +`Operator.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the matrix power of the operator. @@ -304,7 +304,7 @@ BaseOperator -`Operator.reverse_qargs()` +`Operator.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return an Operator with reversed subsystem ordering. @@ -322,7 +322,7 @@ the operator with reversed subsystem order. -`Operator.tensor(other)` +`Operator.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the tensor product with another Operator. @@ -348,7 +348,7 @@ is the current Operator, and $b$ is the other Operator. -`Operator.to_instruction()` +`Operator.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Convert to a UnitaryGate instruction. @@ -356,7 +356,7 @@ Convert to a UnitaryGate instruction. -`Operator.to_matrix()` +`Operator.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to NumPy matrix. @@ -364,7 +364,7 @@ Convert operator to NumPy matrix. -`Operator.to_operator()` +`Operator.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Convert operator to matrix operator class @@ -372,7 +372,7 @@ Convert operator to matrix operator class -`Operator.transpose()` +`Operator.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/operator.py "view source code") Return the transpose of the Operator. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.PTM.md b/docs/api/qiskit/0.41/qiskit.quantum_info.PTM.md index 2f110e10797..73cf68e466d 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.PTM.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.PTM --- -# PTM[¶](#ptm "Permalink to this headline") +# PTM -`PTM(data, input_dims=None, output_dims=None)` +`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -60,7 +60,7 @@ If the input or output dimensions are None, they will be automatically determine -`PTM.adjoint()` +`PTM.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the adjoint quantum channel. @@ -72,7 +72,7 @@ Return the adjoint quantum channel. -`PTM.compose(other, qargs=None, front=False)` +`PTM.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the operator composition with another PTM. @@ -104,7 +104,7 @@ The composed PTM. -`PTM.conjugate()` +`PTM.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the conjugate quantum channel. @@ -149,7 +149,7 @@ The right matrix multiplied Operator. -`PTM.expand(other)` +`PTM.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the reverse-order tensor product with another PTM. @@ -273,7 +273,7 @@ BaseOperator -`PTM.tensor(other)` +`PTM.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the tensor product with another PTM. @@ -329,7 +329,7 @@ Try to convert channel to a unitary representation Operator. -`PTM.transpose()` +`PTM.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/ptm.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Pauli.md b/docs/api/qiskit/0.41/qiskit.quantum_info.Pauli.md index f7e3be45770..21b8cce21d7 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Pauli.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.Pauli --- -# Pauli[¶](#pauli "Permalink to this headline") +# Pauli -`Pauli(data=None, x=None, *, z=None, label=None)` +`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` @@ -116,7 +116,7 @@ When using the symplectic array input data both z and x arguments must be provid -`Pauli.adjoint()` +`Pauli.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the adjoint of the Operator. @@ -124,7 +124,7 @@ Return the adjoint of the Operator. -`Pauli.anticommutes(other, qargs=None)` +`Pauli.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if other Pauli anticommutes with self. @@ -145,7 +145,7 @@ bool -`Pauli.commutes(other, qargs=None)` +`Pauli.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if the Pauli commutes with other. @@ -166,7 +166,7 @@ bool -`Pauli.compose(other, qargs=None, front=False, inplace=False)` +`Pauli.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the operator composition with another Pauli. @@ -199,7 +199,7 @@ The composed Pauli. -`Pauli.conjugate()` +`Pauli.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the conjugate of each Pauli in the list. @@ -215,7 +215,7 @@ Make a deep copy of current operator. -`Pauli.delete(qubits)` +`Pauli.delete(qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return a Pauli with qubits deleted. @@ -239,7 +239,7 @@ the resulting Pauli with the specified qubits removed. -`Pauli.dot(other, qargs=None, inplace=False)` +`Pauli.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the right multiplied operator self \* other. @@ -261,7 +261,7 @@ The operator self \* other. -`Pauli.equiv(other)` +`Pauli.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return True if Pauli’s are equivalent up to group phase. @@ -281,7 +281,7 @@ bool -`Pauli.evolve(other, qargs=None, frame='h')` +`Pauli.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Heisenberg picture evolution of a Pauli by a Clifford. @@ -311,7 +311,7 @@ the Pauli $C^\dagger.P.C$. -`Pauli.expand(other)` +`Pauli.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the reverse-order tensor product with another Pauli. @@ -341,7 +341,7 @@ Return tuple of input dimension for specified subsystems. -`Pauli.insert(qubits, value)` +`Pauli.insert(qubits, value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Insert a Pauli at specific qubit value. @@ -366,7 +366,7 @@ the resulting Pauli with the entries inserted. -`Pauli.inverse()` +`Pauli.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the inverse of the Pauli. @@ -432,7 +432,7 @@ BaseOperator -`classmethod Pauli.set_truncation(val)` +`classmethod Pauli.set_truncation(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Set the max number of Pauli characters to display before truncation/ @@ -448,7 +448,7 @@ Set the max number of Pauli characters to display before truncation/ -`Pauli.tensor(other)` +`Pauli.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the tensor product with another Pauli. @@ -474,7 +474,7 @@ is the current Pauli, and $b$ is the other Pauli. -`Pauli.to_instruction()` +`Pauli.to_instruction()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to Pauli circuit instruction. @@ -482,7 +482,7 @@ Convert to Pauli circuit instruction. -`Pauli.to_label()` +`Pauli.to_label()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert a Pauli to a string label. @@ -502,7 +502,7 @@ str -`Pauli.to_matrix(sparse=False)` +`Pauli.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Convert to a Numpy array or sparse CSR matrix. @@ -522,7 +522,7 @@ array -`Pauli.transpose()` +`Pauli.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Return the transpose of each Pauli in the list. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.PauliList.md b/docs/api/qiskit/0.41/qiskit.quantum_info.PauliList.md index 79312808444..ac85fb782f6 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.PauliList.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.PauliList --- -# PauliList[¶](#paulilist "Permalink to this headline") +# PauliList -`PauliList(data)` +`PauliList(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli`, `qiskit.quantum_info.operators.mixins.linear.LinearMixin`, `qiskit.quantum_info.operators.mixins.group.GroupMixin` @@ -110,7 +110,7 @@ The input array is not copied so multiple Pauli tables can share the same underl -`PauliList.adjoint()` +`PauliList.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the adjoint of each Pauli in the list. @@ -118,7 +118,7 @@ Return the adjoint of each Pauli in the list. -`PauliList.anticommutes(other, qargs=None)` +`PauliList.anticommutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True if other Pauli that anticommutes with other. @@ -139,7 +139,7 @@ bool -`PauliList.anticommutes_with_all(other)` +`PauliList.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -161,7 +161,7 @@ array -`PauliList.argsort(weight=False, phase=False)` +`PauliList.argsort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indices for sorting the rows of the table. @@ -184,7 +184,7 @@ array -`PauliList.commutes(other, qargs=None)` +`PauliList.commutes(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return True for each Pauli that commutes with other. @@ -205,7 +205,7 @@ bool -`PauliList.commutes_with_all(other)` +`PauliList.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return indexes of rows that commute other. @@ -227,7 +227,7 @@ array -`PauliList.compose(other, qargs=None, front=False, inplace=False)` +`PauliList.compose(other, qargs=None, front=False, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition self∘other for each Pauli in the list. @@ -254,7 +254,7 @@ the list of composed Paulis. -`PauliList.conjugate()` +`PauliList.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the conjugate of each Pauli in the list. @@ -270,7 +270,7 @@ Make a deep copy of current operator. -`PauliList.delete(ind, qubit=False)` +`PauliList.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a copy with Pauli rows deleted from table. @@ -297,7 +297,7 @@ the resulting table with the entries removed. -`PauliList.dot(other, qargs=None, inplace=False)` +`PauliList.dot(other, qargs=None, inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the composition other∘self for each Pauli in the list. @@ -323,7 +323,7 @@ the list of composed Paulis. -`PauliList.equiv(other)` +`PauliList.equiv(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Entrywise comparison of Pauli equivalence up to global phase. @@ -345,7 +345,7 @@ np.ndarray -`PauliList.evolve(other, qargs=None, frame='h')` +`PauliList.evolve(other, qargs=None, frame='h')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Evolve the Pauli by a Clifford. @@ -375,7 +375,7 @@ the Pauli $C.P.C^\dagger$. -`PauliList.expand(other)` +`PauliList.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the expand product of each Pauli in the list. @@ -399,7 +399,7 @@ the list of tensor product Paulis. -`classmethod PauliList.from_symplectic(z, x, phase=0)` +`classmethod PauliList.from_symplectic(z, x, phase=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Construct a PauliList from a symplectic data. @@ -421,7 +421,7 @@ the constructed PauliList. -`PauliList.group_commuting(qubit_wise=False)` +`PauliList.group_commuting(qubit_wise=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of commuting Pauli strings. @@ -452,7 +452,7 @@ List\[[PauliList](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") -`PauliList.group_qubit_wise_commuting()` +`PauliList.group_qubit_wise_commuting()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Partition a PauliList into sets of mutually qubit-wise commuting Pauli strings. @@ -476,7 +476,7 @@ Return tuple of input dimension for specified subsystems. -`PauliList.insert(ind, value, qubit=False)` +`PauliList.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Insert Pauli’s into the table. @@ -504,7 +504,7 @@ the resulting table with the entries inserted. -`PauliList.inverse()` +`PauliList.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the inverse of each Pauli in the list. @@ -512,7 +512,7 @@ Return the inverse of each Pauli in the list. -`PauliList.label_iter()` +`PauliList.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a label representation iterator. @@ -530,7 +530,7 @@ LabelIterator -`PauliList.matrix_iter(sparse=False)` +`PauliList.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return a matrix representation iterator. @@ -610,7 +610,7 @@ BaseOperator -`PauliList.sort(weight=False, phase=False)` +`PauliList.sort(weight=False, phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Sort the rows of the table. @@ -673,7 +673,7 @@ a sorted copy of the original table. -`PauliList.tensor(other)` +`PauliList.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the tensor product with each Pauli in the list. @@ -697,7 +697,7 @@ the list of tensor product Paulis. -`PauliList.to_labels(array=False)` +`PauliList.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert a PauliList to a list Pauli string labels. @@ -726,7 +726,7 @@ list or array -`PauliList.to_matrix(sparse=False, array=False)` +`PauliList.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Convert to a list or array of Pauli matrices. @@ -756,7 +756,7 @@ list -`PauliList.transpose()` +`PauliList.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return the transpose of each Pauli in the list. @@ -764,7 +764,7 @@ Return the transpose of each Pauli in the list. -`PauliList.unique(return_index=False, return_counts=False)` +`PauliList.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_list.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.PauliTable.md b/docs/api/qiskit/0.41/qiskit.quantum_info.PauliTable.md index 834d4aed0a7..fae9e22dfcd 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.PauliTable.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.PauliTable --- -# PauliTable[¶](#paulitable "Permalink to this headline") +# PauliTable -`PauliTable(data)` +`PauliTable(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -97,7 +97,7 @@ Return the adjoint of the Operator. -`PauliTable.anticommutes_with_all(other)` +`PauliTable.anticommutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -119,7 +119,7 @@ array -`PauliTable.argsort(weight=False)` +`PauliTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indices for sorting the rows of the table. @@ -141,7 +141,7 @@ array -`PauliTable.commutes(pauli)` +`PauliTable.commutes(pauli)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return list of commutation properties for each row with a Pauli. @@ -167,7 +167,7 @@ array -`PauliTable.commutes_with_all(other)` +`PauliTable.commutes_with_all(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return indexes of rows that commute other. @@ -189,7 +189,7 @@ array -`PauliTable.compose(other, qargs=None, front=True)` +`PauliTable.compose(other, qargs=None, front=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the compose output product of two tables. @@ -231,7 +231,7 @@ the compose outer product table. -`PauliTable.conjugate()` +`PauliTable.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -247,11 +247,11 @@ Make a deep copy of current operator. -`PauliTable.delete(ind, qubit=False)` +`PauliTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a copy with Pauli rows deleted from table. -When deleting qubits the qubit index is the same as the column index of the underlying [`X`](qiskit.quantum_info.PauliTable#X "qiskit.quantum_info.PauliTable.X") and [`Z`](qiskit.quantum_info.PauliTable#Z "qiskit.quantum_info.PauliTable.Z") arrays. +When deleting qubits the qubit index is the same as the column index of the underlying [`X`](qiskit.quantum_info.PauliTable#x "qiskit.quantum_info.PauliTable.X") and [`Z`](qiskit.quantum_info.PauliTable#z "qiskit.quantum_info.PauliTable.Z") arrays. **Parameters** @@ -274,7 +274,7 @@ the resulting table with the entries removed. -`PauliTable.dot(other, qargs=None)` +`PauliTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the dot output product of two tables. @@ -315,7 +315,7 @@ the dot outer product table. -`PauliTable.expand(other)` +`PauliTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the expand output product of two tables. @@ -355,7 +355,7 @@ the expand outer product table. -`classmethod PauliTable.from_labels(labels)` +`classmethod PauliTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Construct a PauliTable from a list of Pauli strings. @@ -388,11 +388,11 @@ Return tuple of input dimension for specified subsystems. -`PauliTable.insert(ind, value, qubit=False)` +`PauliTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Insert Pauli’s into the table. -When inserting qubits the qubit index is the same as the column index of the underlying [`X`](qiskit.quantum_info.PauliTable#X "qiskit.quantum_info.PauliTable.X") and [`Z`](qiskit.quantum_info.PauliTable#Z "qiskit.quantum_info.PauliTable.Z") arrays. +When inserting qubits the qubit index is the same as the column index of the underlying [`X`](qiskit.quantum_info.PauliTable#x "qiskit.quantum_info.PauliTable.X") and [`Z`](qiskit.quantum_info.PauliTable#z "qiskit.quantum_info.PauliTable.Z") arrays. **Parameters** @@ -416,7 +416,7 @@ the resulting table with the entries inserted. -`PauliTable.label_iter()` +`PauliTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a label representation iterator. @@ -434,7 +434,7 @@ LabelIterator -`PauliTable.matrix_iter(sparse=False)` +`PauliTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return a matrix representation iterator. @@ -514,7 +514,7 @@ BaseOperator -`PauliTable.sort(weight=False)` +`PauliTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Sort the rows of the table. @@ -582,7 +582,7 @@ a sorted copy of the original table. -`PauliTable.tensor(other)` +`PauliTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return the tensor output product of two tables. @@ -622,7 +622,7 @@ the tensor outer product table. -`PauliTable.to_labels(array=False)` +`PauliTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert a PauliTable to a list Pauli string labels. @@ -651,7 +651,7 @@ list or array -`PauliTable.to_matrix(sparse=False, array=False)` +`PauliTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Convert to a list or array of Pauli matrices. @@ -681,7 +681,7 @@ list -`PauliTable.transpose()` +`PauliTable.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Not implemented. @@ -689,7 +689,7 @@ Not implemented. -`PauliTable.unique(return_index=False, return_counts=False)` +`PauliTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_table.py "view source code") Return unique Paulis from the table. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.41/qiskit.quantum_info.Quaternion.md index 5ee5b539bf0..dadfbb98453 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Quaternion.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.Quaternion --- -# Quaternion[¶](#quaternion "Permalink to this headline") +# Quaternion -`Quaternion(data)` +`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ A class representing a Quaternion. -`classmethod Quaternion.from_axis_rotation(angle, axis)` +`classmethod Quaternion.from_axis_rotation(angle, axis)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Return quaternion for rotation about given axis. @@ -47,7 +47,7 @@ Quaternion for axis rotation. -`classmethod Quaternion.from_euler(angles, order='yzy')` +`classmethod Quaternion.from_euler(angles, order='yzy')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Generate a quaternion from a set of Euler angles. @@ -68,7 +68,7 @@ Quaternion representation of Euler rotation. -`Quaternion.norm()` +`Quaternion.norm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Norm of quaternion. @@ -76,7 +76,7 @@ Norm of quaternion. -`Quaternion.normalize(inplace=False)` +`Quaternion.normalize(inplace=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Normalizes a Quaternion to unit length so that it represents a valid rotation. @@ -96,7 +96,7 @@ Normalized quaternion. -`Quaternion.to_matrix()` +`Quaternion.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a rotation matrix. @@ -112,7 +112,7 @@ ndarray -`Quaternion.to_zyz()` +`Quaternion.to_zyz()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/quaternion.py "view source code") Converts a unit-length quaternion to a sequence of ZYZ Euler angles. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.ScalarOp.md b/docs/api/qiskit/0.41/qiskit.quantum_info.ScalarOp.md index 3e20f6bd20a..3eb55199958 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.ScalarOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.ScalarOp --- -# ScalarOp[¶](#scalarop "Permalink to this headline") +# ScalarOp -`ScalarOp(dims=None, coeff=1)` +`ScalarOp(dims=None, coeff=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -43,7 +43,7 @@ Return the adjoint of the Operator. -`ScalarOp.compose(other, qargs=None, front=False)` +`ScalarOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the operator composition with another ScalarOp. @@ -75,7 +75,7 @@ The composed ScalarOp. -`ScalarOp.conjugate()` +`ScalarOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the conjugate of the ScalarOp. @@ -116,7 +116,7 @@ The right matrix multiplied Operator. -`ScalarOp.expand(other)` +`ScalarOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the reverse-order tensor product with another ScalarOp. @@ -146,7 +146,7 @@ Return tuple of input dimension for specified subsystems. -`ScalarOp.is_unitary(atol=None, rtol=None)` +`ScalarOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return True if operator is a unitary matrix. @@ -162,7 +162,7 @@ Return tuple of output dimension for specified subsystems. -`ScalarOp.power(n)` +`ScalarOp.power(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the power of the ScalarOp. @@ -208,7 +208,7 @@ BaseOperator -`ScalarOp.tensor(other)` +`ScalarOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the tensor product with another ScalarOp. @@ -234,7 +234,7 @@ is the current ScalarOp, and $b$ is the other ScalarOp. -`ScalarOp.to_matrix()` +`ScalarOp.to_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to a Numpy matrix. @@ -242,7 +242,7 @@ Convert to a Numpy matrix. -`ScalarOp.to_operator()` +`ScalarOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Convert to an Operator object. @@ -250,7 +250,7 @@ Convert to an Operator object. -`ScalarOp.transpose()` +`ScalarOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/scalar_op.py "view source code") Return the transpose of the ScalarOp. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.SparsePauliOp.md b/docs/api/qiskit/0.41/qiskit.quantum_info.SparsePauliOp.md index 5c02aff4cea..01b83eea340 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.SparsePauliOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.SparsePauliOp --- -# SparsePauliOp[¶](#sparsepauliop "Permalink to this headline") +# SparsePauliOp -`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)` +`SparsePauliOp(data, coeffs=None, *, ignore_pauli_phase=False, copy=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` @@ -74,7 +74,7 @@ Initialize an operator object. -`SparsePauliOp.adjoint()` +`SparsePauliOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the adjoint of the Operator. @@ -82,7 +82,7 @@ Return the adjoint of the Operator. -`SparsePauliOp.argsort(weight=False)` +`SparsePauliOp.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return indices for sorting the rows of the table. @@ -152,7 +152,7 @@ array -`SparsePauliOp.chop(tol=1e-14)` +`SparsePauliOp.chop(tol=1e-14)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Set real and imaginary parts of the coefficients to 0 if `< tol` in magnitude. @@ -176,7 +176,7 @@ This operator with chopped coefficients. -`SparsePauliOp.compose(other, qargs=None, front=False)` +`SparsePauliOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the operator composition with another SparsePauliOp. @@ -208,7 +208,7 @@ The composed SparsePauliOp. -`SparsePauliOp.conjugate()` +`SparsePauliOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the conjugate of the SparsePauliOp. @@ -249,7 +249,7 @@ The right matrix multiplied Operator. -`SparsePauliOp.equiv(other, atol=None)` +`SparsePauliOp.equiv(other, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Check if two SparsePauliOp operators are equivalent. @@ -270,7 +270,7 @@ bool -`SparsePauliOp.expand(other)` +`SparsePauliOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the reverse-order tensor product with another SparsePauliOp. @@ -292,7 +292,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`static SparsePauliOp.from_list(obj, dtype=)` +`static SparsePauliOp.from_list(obj, dtype=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of Pauli strings and coefficients. @@ -330,7 +330,7 @@ The SparsePauliOp representation of the Pauli terms. -`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)` +`static SparsePauliOp.from_operator(obj, atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from an Operator objector. @@ -358,7 +358,7 @@ the SparsePauliOp representation of the operator. -`static SparsePauliOp.from_sparse_list(obj, num_qubits, do_checks=True, dtype=)` +`static SparsePauliOp.from_sparse_list(obj, num_qubits, do_checks=True, dtype=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Construct from a list of local Pauli strings and coefficients. @@ -405,7 +405,7 @@ The SparsePauliOp representation of the Pauli terms. -`SparsePauliOp.group_commuting(qubit_wise=False)` +`SparsePauliOp.group_commuting(qubit_wise=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Partition a SparsePauliOp into sets of commuting Pauli strings. @@ -448,7 +448,7 @@ Return tuple of input dimension for specified subsystems. -`SparsePauliOp.is_unitary(atol=None, rtol=None)` +`SparsePauliOp.is_unitary(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return True if operator is a unitary matrix. @@ -469,7 +469,7 @@ bool -`SparsePauliOp.label_iter()` +`SparsePauliOp.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a label representation iterator. @@ -487,7 +487,7 @@ LabelIterator -`SparsePauliOp.matrix_iter(sparse=False)` +`SparsePauliOp.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return a matrix representation iterator. @@ -567,7 +567,7 @@ BaseOperator -`SparsePauliOp.simplify(atol=None, rtol=None)` +`SparsePauliOp.simplify(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Simplify PauliList by combining duplicates and removing zeros. @@ -588,7 +588,7 @@ the simplified SparsePauliOp operator. -`SparsePauliOp.sort(weight=False)` +`SparsePauliOp.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sort the rows of the table. @@ -661,7 +661,7 @@ a sorted copy of the original table. -`static SparsePauliOp.sum(ops)` +`static SparsePauliOp.sum(ops)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Sum of SparsePauliOps. @@ -689,7 +689,7 @@ the SparsePauliOp representing the sum of the input list. -`SparsePauliOp.tensor(other)` +`SparsePauliOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the tensor product with another SparsePauliOp. @@ -715,7 +715,7 @@ is the current SparsePauliOp, and $b$ is the other SparsePauliOp. -`SparsePauliOp.to_list(array=False)` +`SparsePauliOp.to_list(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a list Pauli string labels and coefficients. @@ -737,7 +737,7 @@ list or array -`SparsePauliOp.to_matrix(sparse=False)` +`SparsePauliOp.to_matrix(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a dense or sparse matrix. @@ -757,7 +757,7 @@ array -`SparsePauliOp.to_operator()` +`SparsePauliOp.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Convert to a matrix Operator object @@ -765,7 +765,7 @@ Convert to a matrix Operator object -`SparsePauliOp.transpose()` +`SparsePauliOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/sparse_pauli_op.py "view source code") Return the transpose of the SparsePauliOp. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerState.md b/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerState.md index 13808976665..47ed6ef9dd7 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerState.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.StabilizerState --- -# StabilizerState[¶](#stabilizerstate "Permalink to this headline") +# StabilizerState -`StabilizerState(data, validate=True)` +`StabilizerState(data, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState` @@ -59,7 +59,7 @@ Initialize a StabilizerState object. -`StabilizerState.conjugate()` +`StabilizerState.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the conjugate of the operator. @@ -83,7 +83,7 @@ Return tuple of input dimension for specified subsystems. -`StabilizerState.evolve(other, qargs=None)` +`StabilizerState.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Evolve a stabilizer state by a Clifford operator. @@ -109,7 +109,7 @@ the output stabilizer state. -`StabilizerState.expand(other)` +`StabilizerState.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state other ⊗ self. @@ -133,7 +133,7 @@ the tensor product operator other ⊗ self. -`StabilizerState.expectation_value(oper, qargs=None)` +`StabilizerState.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Compute the expectation value of a Pauli operator. @@ -158,7 +158,7 @@ complex -`StabilizerState.is_valid(atol=None, rtol=None)` +`StabilizerState.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return True if a valid StabilizerState. @@ -166,7 +166,7 @@ Return True if a valid StabilizerState. -`StabilizerState.measure(qargs=None)` +`StabilizerState.measure(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Measure subsystems and return outcome and post-measure state. @@ -190,7 +190,7 @@ tuple -`StabilizerState.probabilities(qargs=None, decimals=None)` +`StabilizerState.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability vector. @@ -213,7 +213,7 @@ np.array -`StabilizerState.probabilities_dict(qargs=None, decimals=None)` +`StabilizerState.probabilities_dict(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the subsystem measurement probability dictionary. @@ -238,7 +238,7 @@ dict -`StabilizerState.purity()` +`StabilizerState.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the purity of the quantum state, which equals to 1, since it is always a pure state. @@ -258,7 +258,7 @@ double -`StabilizerState.reset(qargs=None)` +`StabilizerState.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Reset state or subsystems to the 0-state. @@ -309,7 +309,7 @@ Additional Information: -`StabilizerState.sample_memory(shots, qargs=None)` +`StabilizerState.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -344,7 +344,7 @@ Set the seed for the quantum state RNG. -`StabilizerState.tensor(other)` +`StabilizerState.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the tensor product stabilzier state self ⊗ other. @@ -368,7 +368,7 @@ the tensor product operator self ⊗ other. -`StabilizerState.to_operator()` +`StabilizerState.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Convert state to matrix operator class @@ -376,7 +376,7 @@ Convert state to matrix operator class -`StabilizerState.trace()` +`StabilizerState.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/stabilizerstate.py "view source code") Return the trace of the stabilizer state as a density matrix, which equals to 1, since it is always a pure state. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerTable.md b/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerTable.md index 62bfb279298..e82185cdc61 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.StabilizerTable.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.StabilizerTable --- -# StabilizerTable[¶](#stabilizertable "Permalink to this headline") +# StabilizerTable -`StabilizerTable(data, phase=None)` +`StabilizerTable(data, phase=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Bases: [`qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.operators.symplectic.pauli_table.PauliTable"), `qiskit.quantum_info.operators.mixins.adjoint.AdjointMixin` @@ -130,7 +130,7 @@ array -`StabilizerTable.argsort(weight=False)` +`StabilizerTable.argsort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return indices for sorting the rows of the PauliTable. @@ -202,7 +202,7 @@ array -`StabilizerTable.compose(other, qargs=None, front=False)` +`StabilizerTable.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the compose output product of two tables. @@ -263,7 +263,7 @@ Not implemented. -`StabilizerTable.copy()` +`StabilizerTable.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy of the StabilizerTable. @@ -271,11 +271,11 @@ Return a copy of the StabilizerTable. -`StabilizerTable.delete(ind, qubit=False)` +`StabilizerTable.delete(ind, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a copy with Stabilizer rows deleted from table. -When deleting qubit columns, qubit-0 is the right-most (largest index) column, and qubit-(N-1) is the left-most (0 index) column of the underlying [`X`](qiskit.quantum_info.StabilizerTable#X "qiskit.quantum_info.StabilizerTable.X") and [`Z`](qiskit.quantum_info.StabilizerTable#Z "qiskit.quantum_info.StabilizerTable.Z") arrays. +When deleting qubit columns, qubit-0 is the right-most (largest index) column, and qubit-(N-1) is the left-most (0 index) column of the underlying [`X`](qiskit.quantum_info.StabilizerTable#x "qiskit.quantum_info.StabilizerTable.X") and [`Z`](qiskit.quantum_info.StabilizerTable#z "qiskit.quantum_info.StabilizerTable.Z") arrays. **Parameters** @@ -298,7 +298,7 @@ the resulting table with the entries removed. -`StabilizerTable.dot(other, qargs=None)` +`StabilizerTable.dot(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the dot output product of two tables. @@ -348,7 +348,7 @@ the dot outer product table. -`StabilizerTable.expand(other)` +`StabilizerTable.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the expand output product of two tables. @@ -388,7 +388,7 @@ the expand outer product table. -`classmethod StabilizerTable.from_labels(labels)` +`classmethod StabilizerTable.from_labels(labels)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Construct a StabilizerTable from a list of Pauli stabilizer strings. @@ -433,11 +433,11 @@ Return tuple of input dimension for specified subsystems. -`StabilizerTable.insert(ind, value, qubit=False)` +`StabilizerTable.insert(ind, value, qubit=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Insert stabilizers’s into the table. -When inserting qubit columns, qubit-0 is the right-most (largest index) column, and qubit-(N-1) is the left-most (0 index) column of the underlying [`X`](qiskit.quantum_info.StabilizerTable#X "qiskit.quantum_info.StabilizerTable.X") and [`Z`](qiskit.quantum_info.StabilizerTable#Z "qiskit.quantum_info.StabilizerTable.Z") arrays. +When inserting qubit columns, qubit-0 is the right-most (largest index) column, and qubit-(N-1) is the left-most (0 index) column of the underlying [`X`](qiskit.quantum_info.StabilizerTable#x "qiskit.quantum_info.StabilizerTable.X") and [`Z`](qiskit.quantum_info.StabilizerTable#z "qiskit.quantum_info.StabilizerTable.Z") arrays. **Parameters** @@ -461,7 +461,7 @@ the resulting table with the entries inserted. -`StabilizerTable.label_iter()` +`StabilizerTable.label_iter()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a label representation iterator. @@ -479,7 +479,7 @@ LabelIterator -`StabilizerTable.matrix_iter(sparse=False)` +`StabilizerTable.matrix_iter(sparse=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return a matrix representation iterator. @@ -559,7 +559,7 @@ BaseOperator -`StabilizerTable.sort(weight=False)` +`StabilizerTable.sort(weight=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Sort the rows of the table. @@ -632,7 +632,7 @@ a sorted copy of the original table. -`StabilizerTable.tensor(other)` +`StabilizerTable.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return the tensor output product of two tables. @@ -672,7 +672,7 @@ the tensor outer product table. -`StabilizerTable.to_labels(array=False)` +`StabilizerTable.to_labels(array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert a StabilizerTable to a list Pauli stabilizer string labels. @@ -705,7 +705,7 @@ list or array -`StabilizerTable.to_matrix(sparse=False, array=False)` +`StabilizerTable.to_matrix(sparse=False, array=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Convert to a list or array of Stabilizer matrices. @@ -747,7 +747,7 @@ Not implemented. -`StabilizerTable.unique(return_index=False, return_counts=False)` +`StabilizerTable.unique(return_index=False, return_counts=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/stabilizer_table.py "view source code") Return unique stabilizers from the table. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.41/qiskit.quantum_info.Statevector.md index 94453df949b..121f43d8e80 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Statevector.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.Statevector --- -# Statevector[¶](#statevector "Permalink to this headline") +# Statevector -`Statevector(data, dims=None)` +`Statevector(data, dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Bases: `qiskit.quantum_info.states.quantum_state.QuantumState`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -40,7 +40,7 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. -`Statevector.conjugate()` +`Statevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the conjugate of the operator. @@ -64,7 +64,7 @@ Return tuple of input dimension for specified subsystems. -`Statevector.draw(output=None, **drawer_args)` +`Statevector.draw(output=None, **drawer_args)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return a visualization of the Statevector. @@ -116,7 +116,7 @@ sv.draw(output='hinton') -`Statevector.equiv(other, rtol=None, atol=None)` +`Statevector.equiv(other, rtol=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return True if other is equivalent as a statevector up to global phase. @@ -142,7 +142,7 @@ bool -`Statevector.evolve(other, qargs=None)` +`Statevector.evolve(other, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Evolve a quantum state by the operator. @@ -167,7 +167,7 @@ the output quantum state. -`Statevector.expand(other)` +`Statevector.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state other ⊗ self. @@ -191,7 +191,7 @@ the tensor product state other ⊗ self. -`Statevector.expectation_value(oper, qargs=None)` +`Statevector.expectation_value(oper, qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Compute the expectation value of an operator. @@ -212,7 +212,7 @@ complex -`classmethod Statevector.from_instruction(instruction)` +`classmethod Statevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the output statevector of an instruction. @@ -238,7 +238,7 @@ The final statevector. -`static Statevector.from_int(i, dims)` +`static Statevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return a computational basis statevector. @@ -266,7 +266,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod Statevector.from_label(label)` +`classmethod Statevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -299,7 +299,7 @@ The N-qubit basis state density matrix. -`Statevector.inner(other)` +`Statevector.inner(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the inner product of self and other as $\langle self| other \rangle$. @@ -323,7 +323,7 @@ np.complex128 -`Statevector.is_valid(atol=None, rtol=None)` +`Statevector.is_valid(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return True if a Statevector has norm 1. @@ -355,7 +355,7 @@ tuple -`Statevector.probabilities(qargs=None, decimals=None)` +`Statevector.probabilities(qargs=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the subsystem measurement probability vector. @@ -453,7 +453,7 @@ dict -`Statevector.purity()` +`Statevector.purity()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the purity of the quantum state. @@ -461,7 +461,7 @@ Return the purity of the quantum state. -`Statevector.reset(qargs=None)` +`Statevector.reset(qargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Reset state or subsystems to the 0-state. @@ -485,7 +485,7 @@ If all subsystems are reset this will return the ground state on all subsystems. -`Statevector.reverse_qargs()` +`Statevector.reverse_qargs()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return a Statevector with reversed subsystem ordering. @@ -565,7 +565,7 @@ Set the seed for the quantum state RNG. -`Statevector.tensor(other)` +`Statevector.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the tensor product state self ⊗ other. @@ -589,7 +589,7 @@ the tensor product operator self ⊗ other. -`Statevector.to_dict(decimals=None)` +`Statevector.to_dict(decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Convert the statevector to dictionary form. @@ -660,7 +660,7 @@ print(psi.to_dict()) -`Statevector.to_operator()` +`Statevector.to_operator()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Convert state to a rank-1 projector operator @@ -668,7 +668,7 @@ Convert state to a rank-1 projector operator -`Statevector.trace()` +`Statevector.trace()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/statevector.py "view source code") Return the trace of the quantum state as a density matrix. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.Stinespring.md b/docs/api/qiskit/0.41/qiskit.quantum_info.Stinespring.md index 09799941d28..4785c111e80 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.Stinespring.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.Stinespring --- -# Stinespring[¶](#stinespring "Permalink to this headline") +# Stinespring -`Stinespring(data, input_dims=None, output_dims=None)` +`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -70,7 +70,7 @@ Return the adjoint quantum channel. -`Stinespring.compose(other, qargs=None, front=False)` +`Stinespring.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the operator composition with another Stinespring. @@ -102,7 +102,7 @@ The composed Stinespring. -`Stinespring.conjugate()` +`Stinespring.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the conjugate quantum channel. @@ -147,7 +147,7 @@ The right matrix multiplied Operator. -`Stinespring.expand(other)` +`Stinespring.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the reverse-order tensor product with another Stinespring. @@ -185,7 +185,7 @@ Test if Choi-matrix is completely-positive (CP) -`Stinespring.is_cptp(atol=None, rtol=None)` +`Stinespring.is_cptp(atol=None, rtol=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return True if completely-positive trace-preserving. @@ -271,7 +271,7 @@ BaseOperator -`Stinespring.tensor(other)` +`Stinespring.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the tensor product with another Stinespring. @@ -327,7 +327,7 @@ Try to convert channel to a unitary representation Operator. -`Stinespring.transpose()` +`Stinespring.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.SuperOp.md b/docs/api/qiskit/0.41/qiskit.quantum_info.SuperOp.md index 4f51285e3da..10969ee32c4 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.SuperOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.SuperOp --- -# SuperOp[¶](#superop "Permalink to this headline") +# SuperOp -`SuperOp(data, input_dims=None, output_dims=None)` +`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -52,7 +52,7 @@ If the input or output dimensions are None, they will be automatically determine -`SuperOp.adjoint()` +`SuperOp.adjoint()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the adjoint quantum channel. @@ -64,7 +64,7 @@ Return the adjoint quantum channel. -`SuperOp.compose(other, qargs=None, front=False)` +`SuperOp.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the operator composition with another SuperOp. @@ -96,7 +96,7 @@ The composed SuperOp. -`SuperOp.conjugate()` +`SuperOp.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the conjugate quantum channel. @@ -141,7 +141,7 @@ The right matrix multiplied Operator. -`SuperOp.expand(other)` +`SuperOp.expand(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the reverse-order tensor product with another SuperOp. @@ -265,7 +265,7 @@ BaseOperator -`SuperOp.tensor(other)` +`SuperOp.tensor(other)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the tensor product with another SuperOp. @@ -321,7 +321,7 @@ Try to convert channel to a unitary representation Operator. -`SuperOp.transpose()` +`SuperOp.transpose()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/channel/superop.py "view source code") Return the transpose quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.TwoQubitBasisDecomposer.md b/docs/api/qiskit/0.41/qiskit.quantum_info.TwoQubitBasisDecomposer.md index f1a1c69b880..2eb121a3e84 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer --- -# TwoQubitBasisDecomposer[¶](#twoqubitbasisdecomposer "Permalink to this headline") +# TwoQubitBasisDecomposer -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)` +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub -`static TwoQubitBasisDecomposer.decomp0(target)` +`static TwoQubitBasisDecomposer.decomp0(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trace: $|Tr(Ur.Utarget^dag)| = 4|(cos(x)cos(y)cos(z)+ j sin(x)sin(y)sin(z)|$, which is optimal for all targets and bases @@ -37,7 +37,7 @@ Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. Result Ur has trac -`TwoQubitBasisDecomposer.decomp1(target)` +`TwoQubitBasisDecomposer.decomp1(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 1 uses of the basis gate \~Ud(a, b, c). Result Ur has trace: .. math: @@ -51,7 +51,7 @@ which is optimal for all targets and bases with z==0 or c==0 -`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)` +`TwoQubitBasisDecomposer.decomp2_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target \~Ud(x, y, z) with 2 uses of the basis gate. @@ -67,7 +67,7 @@ which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or -`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)` +`TwoQubitBasisDecomposer.decomp3_supercontrolled(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Decompose target with 3 uses of the basis. This is an exact decomposition for supercontrolled basis \~Ud(pi/4, b, 0), all b, and any target. No guarantees for non-supercontrolled basis. @@ -75,7 +75,7 @@ Decompose target with 3 uses of the basis. This is an exact decomposition for su -`TwoQubitBasisDecomposer.num_basis_gates(unitary)` +`TwoQubitBasisDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Computes the number of basis gates needed in a decomposition of input unitary @@ -83,7 +83,7 @@ Computes the number of basis gates needed in a decomposition of input unitary -`TwoQubitBasisDecomposer.traces(target)` +`TwoQubitBasisDecomposer.traces(target)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Give the expected traces $|Tr(U \cdot Utarget^dag)|$ for different number of basis gates. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.XXDecomposer.md b/docs/api/qiskit/0.41/qiskit.quantum_info.XXDecomposer.md index bc42fb95b62..4502672b04e 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.XXDecomposer.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.XXDecomposer.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.quantum_info.XXDecomposer --- -# XXDecomposer[¶](#xxdecomposer "Permalink to this headline") +# XXDecomposer -`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)` +`XXDecomposer(euler_basis='U', embodiments=None, backup_optimizer=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates -`XXDecomposer.num_basis_gates(unitary)` +`XXDecomposer.num_basis_gates(unitary)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/xx_decompose/decomposer.py "view source code") Counts the number of gates that would be emitted during re-synthesis. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.average_gate_fidelity.md b/docs/api/qiskit/0.41/qiskit.quantum_info.average_gate_fidelity.md index df4f240001d..68b7ee87ff1 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.average_gate_fidelity.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.average_gate_fidelity.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.average_gate_fidelity --- -# qiskit.quantum\_info.average\_gate\_fidelity[¶](#qiskit-quantum-info-average-gate-fidelity "Permalink to this headline") +# qiskit.quantum\_info.average\_gate\_fidelity -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.concurrence.md b/docs/api/qiskit/0.41/qiskit.quantum_info.concurrence.md index cc456d27053..462b4510c77 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.concurrence.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.concurrence --- -# qiskit.quantum\_info.concurrence[¶](#qiskit-quantum-info-concurrence "Permalink to this headline") +# qiskit.quantum\_info.concurrence -`concurrence(state)` +`concurrence(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the concurrence of a quantum state. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.decompose_clifford.md b/docs/api/qiskit/0.41/qiskit.quantum_info.decompose_clifford.md index f9bea81be33..f8a7f2ba40b 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.decompose_clifford.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.decompose_clifford.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.decompose_clifford --- -# qiskit.quantum\_info.decompose\_clifford[¶](#qiskit-quantum-info-decompose-clifford "Permalink to this headline") +# qiskit.quantum\_info.decompose\_clifford -`decompose_clifford(clifford, method=None)` +`decompose_clifford(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/synthesis/clifford_decompose.py "view source code") DEPRECATED: Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.diamond_norm.md b/docs/api/qiskit/0.41/qiskit.quantum_info.diamond_norm.md index a81b4c5869e..4936b0ed129 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.diamond_norm.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.diamond_norm.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.diamond_norm --- -# qiskit.quantum\_info.diamond\_norm[¶](#qiskit-quantum-info-diamond-norm "Permalink to this headline") +# qiskit.quantum\_info.diamond\_norm -`diamond_norm(choi, **kwargs)` +`diamond_norm(choi, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") Return the diamond norm of the input quantum channel object. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.entanglement_of_formation.md b/docs/api/qiskit/0.41/qiskit.quantum_info.entanglement_of_formation.md index 96b7859785b..fb3690b3339 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.entanglement_of_formation.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.entanglement_of_formation.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.entanglement_of_formation --- -# qiskit.quantum\_info.entanglement\_of\_formation[¶](#qiskit-quantum-info-entanglement-of-formation "Permalink to this headline") +# qiskit.quantum\_info.entanglement\_of\_formation -`entanglement_of_formation(state)` +`entanglement_of_formation(state)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the entanglement of formation of quantum state. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.entropy.md b/docs/api/qiskit/0.41/qiskit.quantum_info.entropy.md index 65e72f13238..4db0623c210 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.entropy.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.entropy --- -# qiskit.quantum\_info.entropy[¶](#qiskit-quantum-info-entropy "Permalink to this headline") +# qiskit.quantum\_info.entropy -`entropy(state, base=2)` +`entropy(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the von-Neumann entropy of a quantum state. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.gate_error.md b/docs/api/qiskit/0.41/qiskit.quantum_info.gate_error.md index 8c0b868bb1f..bd50ef1b1f3 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.gate_error.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.gate_error.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.gate_error --- -# qiskit.quantum\_info.gate\_error[¶](#qiskit-quantum-info-gate-error "Permalink to this headline") +# qiskit.quantum\_info.gate\_error -`gate_error(channel, target=None, require_cp=True, require_tp=False)` +`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.hellinger_distance.md b/docs/api/qiskit/0.41/qiskit.quantum_info.hellinger_distance.md index ac653161187..103af45aad4 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.hellinger_distance.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.hellinger_distance.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.hellinger_distance --- -# qiskit.quantum\_info.hellinger\_distance[¶](#qiskit-quantum-info-hellinger-distance "Permalink to this headline") +# qiskit.quantum\_info.hellinger\_distance -`hellinger_distance(dist_p, dist_q)` +`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.hellinger_fidelity.md b/docs/api/qiskit/0.41/qiskit.quantum_info.hellinger_fidelity.md index 5e1f83eb306..08e608bf086 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.hellinger_fidelity.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.hellinger_fidelity.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.hellinger_fidelity --- -# qiskit.quantum\_info.hellinger\_fidelity[¶](#qiskit-quantum-info-hellinger-fidelity "Permalink to this headline") +# qiskit.quantum\_info.hellinger\_fidelity -`hellinger_fidelity(dist_p, dist_q)` +`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.mutual_information.md b/docs/api/qiskit/0.41/qiskit.quantum_info.mutual_information.md index 5294a46d6b0..78bd05e08b2 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.mutual_information.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.mutual_information.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.mutual_information --- -# qiskit.quantum\_info.mutual\_information[¶](#qiskit-quantum-info-mutual-information "Permalink to this headline") +# qiskit.quantum\_info.mutual\_information -`mutual_information(state, base=2)` +`mutual_information(state, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the mutual information of a bipartite state. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.partial_trace.md b/docs/api/qiskit/0.41/qiskit.quantum_info.partial_trace.md index d2af2b384cb..a5270830cd9 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.partial_trace.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.partial_trace.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.partial_trace --- -# qiskit.quantum\_info.partial\_trace[¶](#qiskit-quantum-info-partial-trace "Permalink to this headline") +# qiskit.quantum\_info.partial\_trace -`partial_trace(state, qargs)` +`partial_trace(state, qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/utils.py "view source code") Return reduced density matrix by tracing out part of quantum state. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.pauli_basis.md b/docs/api/qiskit/0.41/qiskit.quantum_info.pauli_basis.md index a898c58833f..924486e0a87 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.pauli_basis.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.pauli_basis.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.pauli_basis --- -# qiskit.quantum\_info.pauli\_basis[¶](#qiskit-quantum-info-pauli-basis "Permalink to this headline") +# qiskit.quantum\_info.pauli\_basis -`pauli_basis(num_qubits, weight=False, pauli_list=None)` +`pauli_basis(num_qubits, weight=False, pauli_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/pauli_utils.py "view source code") Return the ordered PauliTable or PauliList for the n-qubit Pauli basis. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.process_fidelity.md b/docs/api/qiskit/0.41/qiskit.quantum_info.process_fidelity.md index c269b88cace..a8b83a95f9e 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.process_fidelity.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.process_fidelity.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.process_fidelity --- -# qiskit.quantum\_info.process\_fidelity[¶](#qiskit-quantum-info-process-fidelity "Permalink to this headline") +# qiskit.quantum\_info.process\_fidelity -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.purity.md b/docs/api/qiskit/0.41/qiskit.quantum_info.purity.md index c258b56797e..721d246209e 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.purity.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.purity --- -# qiskit.quantum\_info.purity[¶](#qiskit-quantum-info-purity "Permalink to this headline") +# qiskit.quantum\_info.purity -`purity(state, validate=True)` +`purity(state, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Calculate the purity of a quantum state. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_clifford.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_clifford.md index c37269cadfa..d780529e235 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_clifford.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_clifford.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.random_clifford --- -# qiskit.quantum\_info.random\_clifford[¶](#qiskit-quantum-info-random-clifford "Permalink to this headline") +# qiskit.quantum\_info.random\_clifford -`random_clifford(num_qubits, seed=None)` +`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_cnotdihedral.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_cnotdihedral.md index aa5a9d9dc16..593d64f4d0f 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_cnotdihedral.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_cnotdihedral.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.random_cnotdihedral --- -# qiskit.quantum\_info.random\_cnotdihedral[¶](#qiskit-quantum-info-random-cnotdihedral "Permalink to this headline") +# qiskit.quantum\_info.random\_cnotdihedral -`random_cnotdihedral(num_qubits, seed=None)` +`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_density_matrix.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_density_matrix.md index adaa56445b6..3ca0fd49e5d 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_density_matrix.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_density_matrix.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.random_density_matrix --- -# qiskit.quantum\_info.random\_density\_matrix[¶](#qiskit-quantum-info-random-density-matrix "Permalink to this headline") +# qiskit.quantum\_info.random\_density\_matrix -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_hermitian.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_hermitian.md index 22210c97beb..84fc7189411 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_hermitian.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_hermitian.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.random_hermitian --- -# qiskit.quantum\_info.random\_hermitian[¶](#qiskit-quantum-info-random-hermitian "Permalink to this headline") +# qiskit.quantum\_info.random\_hermitian -`random_hermitian(dims, traceless=False, seed=None)` +`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli.md index 3ce010ab53c..d0919d4f951 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.random_pauli --- -# qiskit.quantum\_info.random\_pauli[¶](#qiskit-quantum-info-random-pauli "Permalink to this headline") +# qiskit.quantum\_info.random\_pauli -`random_pauli(num_qubits, group_phase=False, seed=None)` +`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli_list.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli_list.md index 72c478a2742..6574676d30e 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli_list.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli_list.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.random_pauli_list --- -# qiskit.quantum\_info.random\_pauli\_list[¶](#qiskit-quantum-info-random-pauli-list "Permalink to this headline") +# qiskit.quantum\_info.random\_pauli\_list -`random_pauli_list(num_qubits, size=1, seed=None, phase=True)` +`random_pauli_list(num_qubits, size=1, seed=None, phase=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliList. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli_table.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli_table.md index 7439fe91b80..72695d21f9b 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli_table.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_pauli_table.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.random_pauli_table --- -# qiskit.quantum\_info.random\_pauli\_table[¶](#qiskit-quantum-info-random-pauli-table "Permalink to this headline") +# qiskit.quantum\_info.random\_pauli\_table -`random_pauli_table(num_qubits, size=1, seed=None)` +`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_quantum_channel.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_quantum_channel.md index 482ace91d60..8e68bd61b9f 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_quantum_channel.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_quantum_channel.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.random_quantum_channel --- -# qiskit.quantum\_info.random\_quantum\_channel[¶](#qiskit-quantum-info-random-quantum-channel "Permalink to this headline") +# qiskit.quantum\_info.random\_quantum\_channel -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_stabilizer_table.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_stabilizer_table.md index c73764cdf48..0169f9727cb 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_stabilizer_table.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_stabilizer_table.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.random_stabilizer_table --- -# qiskit.quantum\_info.random\_stabilizer\_table[¶](#qiskit-quantum-info-random-stabilizer-table "Permalink to this headline") +# qiskit.quantum\_info.random\_stabilizer\_table -`random_stabilizer_table(num_qubits, size=1, seed=None)` +`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/symplectic/random.py "view source code") DEPRECATED: Return a random StabilizerTable. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_statevector.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_statevector.md index 8a2d5e4a6cf..cce3ed138ff 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_statevector.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_statevector.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.random_statevector --- -# qiskit.quantum\_info.random\_statevector[¶](#qiskit-quantum-info-random-statevector "Permalink to this headline") +# qiskit.quantum\_info.random\_statevector -`random_statevector(dims, seed=None)` +`random_statevector(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/random.py "view source code") Generator a random Statevector. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.random_unitary.md b/docs/api/qiskit/0.41/qiskit.quantum_info.random_unitary.md index 507a3a74db3..e80e975f973 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.random_unitary.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.random_unitary.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.random_unitary --- -# qiskit.quantum\_info.random\_unitary[¶](#qiskit-quantum-info-random-unitary "Permalink to this headline") +# qiskit.quantum\_info.random\_unitary -`random_unitary(dims, seed=None)` +`random_unitary(dims, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/operators/random.py "view source code") Return a random unitary Operator. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.shannon_entropy.md b/docs/api/qiskit/0.41/qiskit.quantum_info.shannon_entropy.md index 5f3cd1ed322..9f2d208b746 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.shannon_entropy.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.shannon_entropy.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.shannon_entropy --- -# qiskit.quantum\_info.shannon\_entropy[¶](#qiskit-quantum-info-shannon-entropy "Permalink to this headline") +# qiskit.quantum\_info.shannon\_entropy -`shannon_entropy(pvec, base=2)` +`shannon_entropy(pvec, base=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/utils.py "view source code") Compute the Shannon entropy of a probability vector. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.state_fidelity.md b/docs/api/qiskit/0.41/qiskit.quantum_info.state_fidelity.md index 4cb6354fb89..4d84e302629 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.state_fidelity.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.state_fidelity.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.quantum_info.state_fidelity --- -# qiskit.quantum\_info.state\_fidelity[¶](#qiskit-quantum-info-state-fidelity "Permalink to this headline") +# qiskit.quantum\_info.state\_fidelity -`state_fidelity(state1, state2, validate=True)` +`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.two_qubit_cnot_decompose.md b/docs/api/qiskit/0.41/qiskit.quantum_info.two_qubit_cnot_decompose.md index b7ffd7c2eca..6436f0b57fe 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.two_qubit_cnot_decompose.md +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.two_qubit_cnot_decompose.md @@ -1,3 +1,3 @@ -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose[¶](#qiskit-quantum-info-two-qubit-cnot-decompose "Permalink to this headline") +# qiskit.quantum\_info.two\_qubit\_cnot\_decompose ## two\_qubit\_cnot\_decompose *= \* diff --git a/docs/api/qiskit/0.41/qiskit.result.BaseReadoutMitigator.md b/docs/api/qiskit/0.41/qiskit.result.BaseReadoutMitigator.md index bc677719f9b..92980da2fff 100644 --- a/docs/api/qiskit/0.41/qiskit.result.BaseReadoutMitigator.md +++ b/docs/api/qiskit/0.41/qiskit.result.BaseReadoutMitigator.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.result.BaseReadoutMitigator --- -# BaseReadoutMitigator[¶](#basereadoutmitigator "Permalink to this headline") +# BaseReadoutMitigator -`BaseReadoutMitigator` +`BaseReadoutMitigator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Base readout error mitigator class. -`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)` +`abstract BaseReadoutMitigator.expectation_value(data, diagonal, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Calculate the expectation value of a diagonal Hermitian operator. @@ -46,7 +46,7 @@ The mean and an upper bound of the standard deviation of operator expectation va -`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` +`abstract BaseReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/base_readout_mitigator.py "view source code") Convert counts to a dictionary of quasi-probabilities diff --git a/docs/api/qiskit/0.41/qiskit.result.CorrelatedReadoutMitigator.md b/docs/api/qiskit/0.41/qiskit.result.CorrelatedReadoutMitigator.md index 2d064d199df..e90496ce5bb 100644 --- a/docs/api/qiskit/0.41/qiskit.result.CorrelatedReadoutMitigator.md +++ b/docs/api/qiskit/0.41/qiskit.result.CorrelatedReadoutMitigator.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.result.CorrelatedReadoutMitigator --- -# CorrelatedReadoutMitigator[¶](#correlatedreadoutmitigator "Permalink to this headline") +# CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)` +`CorrelatedReadoutMitigator(assignment_matrix, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") @@ -35,7 +35,7 @@ Initialize a CorrelatedReadoutMitigator -`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)` +`CorrelatedReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout assignment matrix for specified qubits. @@ -57,7 +57,7 @@ np.ndarray -`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` +`CorrelatedReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -87,7 +87,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)` +`CorrelatedReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return the readout mitigation matrix for the specified qubits. @@ -109,7 +109,7 @@ np.ndarray -`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` +`CorrelatedReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -134,7 +134,7 @@ QuasiDistibution -`CorrelatedReadoutMitigator.stddev_upper_bound(shots)` +`CorrelatedReadoutMitigator.stddev_upper_bound(shots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/correlated_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.41/qiskit.result.Counts.md b/docs/api/qiskit/0.41/qiskit.result.Counts.md index 7a722b6f7f4..7c496d84975 100644 --- a/docs/api/qiskit/0.41/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.41/qiskit.result.Counts.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.result.Counts --- -# Counts[¶](#counts "Permalink to this headline") +# Counts -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Bases: `dict` @@ -74,7 +74,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.hex_outcomes()` +`Counts.hex_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Return a counts dictionary with hexadecimal string keys @@ -96,7 +96,7 @@ dict -`Counts.int_outcomes()` +`Counts.int_outcomes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Build a counts dictionary with integer keys instead of count strings @@ -128,7 +128,7 @@ dict -`Counts.most_frequent()` +`Counts.most_frequent()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Return the most frequent count @@ -176,7 +176,7 @@ Return the value for key if key is in the dictionary, else default. -`Counts.shots()` +`Counts.shots()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/counts.py "view source code") Return the number of shots diff --git a/docs/api/qiskit/0.41/qiskit.result.LocalReadoutMitigator.md b/docs/api/qiskit/0.41/qiskit.result.LocalReadoutMitigator.md index b257399502a..3a5c5fe1cb8 100644 --- a/docs/api/qiskit/0.41/qiskit.result.LocalReadoutMitigator.md +++ b/docs/api/qiskit/0.41/qiskit.result.LocalReadoutMitigator.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.result.LocalReadoutMitigator --- -# LocalReadoutMitigator[¶](#localreadoutmitigator "Permalink to this headline") +# LocalReadoutMitigator -`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)` +`LocalReadoutMitigator(assignment_matrices=None, qubits=None, backend=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Bases: [`qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.mitigation.base_readout_mitigator.BaseReadoutMitigator") @@ -36,7 +36,7 @@ Initialize a LocalReadoutMitigator -`LocalReadoutMitigator.assignment_matrix(qubits=None)` +`LocalReadoutMitigator.assignment_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement assignment matrix for specified qubits. @@ -58,7 +58,7 @@ np.ndarray -`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)` +`LocalReadoutMitigator.expectation_value(data, diagonal=None, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute the mitigated expectation value of a diagonal observable. @@ -88,7 +88,7 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num -`LocalReadoutMitigator.mitigation_matrix(qubits=None)` +`LocalReadoutMitigator.mitigation_matrix(qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return the measurement mitigation matrix for the specified qubits. @@ -110,7 +110,7 @@ np.ndarray -`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)` +`LocalReadoutMitigator.quasi_probabilities(data, qubits=None, clbits=None, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Compute mitigated quasi probabilities value. @@ -139,7 +139,7 @@ QuasiDistibution -`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)` +`LocalReadoutMitigator.stddev_upper_bound(shots, qubits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/mitigation/local_readout_mitigator.py "view source code") Return an upper bound on standard deviation of expval estimator. diff --git a/docs/api/qiskit/0.41/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.41/qiskit.result.ProbDistribution.md index 263505b0b56..8152f25e4ab 100644 --- a/docs/api/qiskit/0.41/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.41/qiskit.result.ProbDistribution.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.result.ProbDistribution --- -# ProbDistribution[¶](#probdistribution "Permalink to this headline") +# ProbDistribution -`ProbDistribution(data, shots=None)` +`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") Bases: `dict` @@ -41,7 +41,7 @@ Builds a probability distribution object. -`ProbDistribution.binary_probabilities(num_bits=None)` +`ProbDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with binary string keys @@ -91,7 +91,7 @@ Return the value for key if key is in the dictionary, else default. -`ProbDistribution.hex_probabilities()` +`ProbDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/probability.py "view source code") Build a probabilities dictionary with hexadecimal string keys diff --git a/docs/api/qiskit/0.41/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.41/qiskit.result.QuasiDistribution.md index af956232377..2ac4bfa64ed 100644 --- a/docs/api/qiskit/0.41/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.41/qiskit.result.QuasiDistribution.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.result.QuasiDistribution --- -# QuasiDistribution[¶](#quasidistribution "Permalink to this headline") +# QuasiDistribution -`QuasiDistribution(data, shots=None, stddev_upper_bound=None)` +`QuasiDistribution(data, shots=None, stddev_upper_bound=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") Bases: `dict` @@ -43,7 +43,7 @@ Builds a quasiprobability distribution object. -`QuasiDistribution.binary_probabilities(num_bits=None)` +`QuasiDistribution.binary_probabilities(num_bits=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with binary string keys @@ -93,7 +93,7 @@ Return the value for key if key is in the dictionary, else default. -`QuasiDistribution.hex_probabilities()` +`QuasiDistribution.hex_probabilities()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") Build a quasi-probabilities dictionary with hexadecimal string keys @@ -123,7 +123,7 @@ dict -`QuasiDistribution.nearest_probability_distribution(return_distance=False)` +`QuasiDistribution.nearest_probability_distribution(return_distance=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/distributions/quasi.py "view source code") Takes a quasiprobability distribution and maps it to the closest probability distribution as defined by the L2-norm. diff --git a/docs/api/qiskit/0.41/qiskit.result.Result.md b/docs/api/qiskit/0.41/qiskit.result.Result.md index 8c09df63aae..20b6e521d37 100644 --- a/docs/api/qiskit/0.41/qiskit.result.Result.md +++ b/docs/api/qiskit/0.41/qiskit.result.Result.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.result.Result --- -# Result[¶](#result "Permalink to this headline") +# Result -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Bases: `object` @@ -82,7 +82,7 @@ list\[ExperimentResult] -`Result.data(experiment=None)` +`Result.data(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the raw data for an experiment. @@ -116,7 +116,7 @@ dict -`classmethod Result.from_dict(data)` +`classmethod Result.from_dict(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Create a new ExperimentResultData object from a dictionary. @@ -136,7 +136,7 @@ The `Result` object from the input dictionary. -`Result.get_counts(experiment=None)` +`Result.get_counts(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the histogram data of an experiment. @@ -160,7 +160,7 @@ dict\[str, int] or list\[dict\[str, int]] -`Result.get_memory(experiment=None)` +`Result.get_memory(experiment=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the sequence of memory states (readouts) for each shot The data from the experiment is a list of format \[‘00000’, ‘01000’, ‘10100’, ‘10100’, ‘11101’, ‘11100’, ‘00101’, …, ‘01010’] @@ -192,7 +192,7 @@ List\[str] or np.ndarray -`Result.get_statevector(experiment=None, decimals=None)` +`Result.get_statevector(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the final statevector of an experiment. @@ -217,7 +217,7 @@ list\[complex] -`Result.get_unitary(experiment=None, decimals=None)` +`Result.get_unitary(experiment=None, decimals=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Get the final unitary of an experiment. @@ -244,7 +244,7 @@ list\[list\[complex]] -`Result.to_dict()` +`Result.to_dict()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/result.py "view source code") Return a dictionary format representation of the Result diff --git a/docs/api/qiskit/0.41/qiskit.result.ResultError.md b/docs/api/qiskit/0.41/qiskit.result.ResultError.md index 8e213179388..5bdc8f10cc3 100644 --- a/docs/api/qiskit/0.41/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.41/qiskit.result.ResultError.md @@ -6,11 +6,11 @@ python_api_type: exception python_api_name: qiskit.result.ResultError --- -# qiskit.result.ResultError[¶](#qiskit-result-resulterror "Permalink to this headline") +# qiskit.result.ResultError -`ResultError(error)` +`ResultError(error)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/exceptions.py "view source code") Exceptions raised due to errors in result output. diff --git a/docs/api/qiskit/0.41/qiskit.result.marginal_counts.md b/docs/api/qiskit/0.41/qiskit.result.marginal_counts.md index 4ca4c1800a6..1d92d6fa354 100644 --- a/docs/api/qiskit/0.41/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.41/qiskit.result.marginal_counts.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.result.marginal_counts --- -# qiskit.result.marginal\_counts[¶](#qiskit-result-marginal-counts "Permalink to this headline") +# qiskit.result.marginal\_counts -`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)` +`marginal_counts(result, indices=None, inplace=False, format_marginal=False, marginalize_memory=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.41/qiskit.result.marginal_distribution.md b/docs/api/qiskit/0.41/qiskit.result.marginal_distribution.md index 5be7b607a26..50fc45b68a3 100644 --- a/docs/api/qiskit/0.41/qiskit.result.marginal_distribution.md +++ b/docs/api/qiskit/0.41/qiskit.result.marginal_distribution.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.result.marginal_distribution --- -# qiskit.result.marginal\_distribution[¶](#qiskit-result-marginal-distribution "Permalink to this headline") +# qiskit.result.marginal\_distribution -`marginal_distribution(counts, indices=None, format_marginal=False)` +`marginal_distribution(counts, indices=None, format_marginal=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") Marginalize counts from an experiment over some indices of interest. diff --git a/docs/api/qiskit/0.41/qiskit.result.marginal_memory.md b/docs/api/qiskit/0.41/qiskit.result.marginal_memory.md index 32d55c45850..90da19986ed 100644 --- a/docs/api/qiskit/0.41/qiskit.result.marginal_memory.md +++ b/docs/api/qiskit/0.41/qiskit.result.marginal_memory.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.result.marginal_memory --- -# qiskit.result.marginal\_memory[¶](#qiskit-result-marginal-memory "Permalink to this headline") +# qiskit.result.marginal\_memory -`marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)` +`marginal_memory(memory, indices=None, int_return=False, hex_return=False, avg_data=False, parallel_threshold=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/utils.py "view source code") Marginalize shot memory diff --git a/docs/api/qiskit/0.41/qiskit.result.sampled_expectation_value.md b/docs/api/qiskit/0.41/qiskit.result.sampled_expectation_value.md index b4b70329a7b..9ae734e4bf5 100644 --- a/docs/api/qiskit/0.41/qiskit.result.sampled_expectation_value.md +++ b/docs/api/qiskit/0.41/qiskit.result.sampled_expectation_value.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.result.sampled_expectation_value --- -# qiskit.result.sampled\_expectation\_value[¶](#qiskit-result-sampled-expectation-value "Permalink to this headline") +# qiskit.result.sampled\_expectation\_value -`sampled_expectation_value(dist, oper)` +`sampled_expectation_value(dist, oper)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/result/sampled_expval.py "view source code") Computes expectation value from a sampled distribution diff --git a/docs/api/qiskit/0.41/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.41/qiskit.scheduler.ScheduleConfig.md index a935a446ed0..7c9c0f199da 100644 --- a/docs/api/qiskit/0.41/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.41/qiskit.scheduler.ScheduleConfig.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.scheduler.ScheduleConfig --- -# ScheduleConfig[¶](#scheduleconfig "Permalink to this headline") +# ScheduleConfig -`ScheduleConfig(inst_map, meas_map, dt)` +`ScheduleConfig(inst_map, meas_map, dt)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/scheduler/config.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.scheduler.methods.basic.md b/docs/api/qiskit/0.41/qiskit.scheduler.methods.basic.md index fad388131eb..5a47337c823 100644 --- a/docs/api/qiskit/0.41/qiskit.scheduler.methods.basic.md +++ b/docs/api/qiskit/0.41/qiskit.scheduler.methods.basic.md @@ -1,6 +1,6 @@ -# qiskit.scheduler.methods.basic[¶](#module-qiskit.scheduler.methods.basic "Permalink to this headline") +# qiskit.scheduler.methods.basic The most straightforward scheduling methods: scheduling **as early** or **as late** as possible. diff --git a/docs/api/qiskit/0.41/qiskit.scheduler.schedule_circuit.md b/docs/api/qiskit/0.41/qiskit.scheduler.schedule_circuit.md index 6ca24e70702..4ba30456e25 100644 --- a/docs/api/qiskit/0.41/qiskit.scheduler.schedule_circuit.md +++ b/docs/api/qiskit/0.41/qiskit.scheduler.schedule_circuit.md @@ -1,6 +1,6 @@ -# qiskit.scheduler.schedule\_circuit[¶](#module-qiskit.scheduler.schedule_circuit "Permalink to this headline") +# qiskit.scheduler.schedule\_circuit QuantumCircuit to Pulse scheduler. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.EvolutionSynthesis.md b/docs/api/qiskit/0.41/qiskit.synthesis.EvolutionSynthesis.md index ca453cbf01d..26150641b6f 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.EvolutionSynthesis.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.EvolutionSynthesis.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.synthesis.EvolutionSynthesis --- -# EvolutionSynthesis[¶](#evolutionsynthesis "Permalink to this headline") +# EvolutionSynthesis -`EvolutionSynthesis` +`EvolutionSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ Interface for evolution synthesis algorithms. -`abstract EvolutionSynthesis.synthesize(evolution)` +`abstract EvolutionSynthesis.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/evolution_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.LieTrotter.md b/docs/api/qiskit/0.41/qiskit.synthesis.LieTrotter.md index 59ae6d759ac..8c970dc8904 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.LieTrotter.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.LieTrotter.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.synthesis.LieTrotter --- -# LieTrotter[¶](#lietrotter "Permalink to this headline") +# LieTrotter -`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` +`LieTrotter(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/lie_trotter.py "view source code") Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -45,7 +45,7 @@ $$ -`LieTrotter.synthesize(evolution)` +`LieTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/lie_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.MatrixExponential.md b/docs/api/qiskit/0.41/qiskit.synthesis.MatrixExponential.md index fbef59fe2f6..c6465577a9b 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.MatrixExponential.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.MatrixExponential.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.synthesis.MatrixExponential --- -# MatrixExponential[¶](#matrixexponential "Permalink to this headline") +# MatrixExponential -`MatrixExponential` +`MatrixExponential`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") @@ -24,7 +24,7 @@ This class synthesis the exponential of operators by calculating their exponenti -`MatrixExponential.synthesize(evolution)` +`MatrixExponential.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/matrix_synthesis.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.ProductFormula.md b/docs/api/qiskit/0.41/qiskit.synthesis.ProductFormula.md index c67e0134f86..a4bf83b6681 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.ProductFormula.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.ProductFormula.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.synthesis.ProductFormula --- -# ProductFormula[¶](#productformula "Permalink to this headline") +# ProductFormula -`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` +`ProductFormula(order, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/product_formula.py "view source code") Bases: [`qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.evolution.evolution_synthesis.EvolutionSynthesis") diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.QDrift.md b/docs/api/qiskit/0.41/qiskit.synthesis.QDrift.md index 9705dade2f4..3d718d06fdb 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.QDrift.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.QDrift.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.synthesis.QDrift --- -# QDrift[¶](#qdrift "Permalink to this headline") +# QDrift -`QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` +`QDrift(reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/qdrift.py "view source code") Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -33,7 +33,7 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza -`QDrift.synthesize(evolution)` +`QDrift.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/qdrift.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.SolovayKitaevDecomposition.md b/docs/api/qiskit/0.41/qiskit.synthesis.SolovayKitaevDecomposition.md index 9770cfa7a3d..7cc7e996aa4 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.SolovayKitaevDecomposition.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.SolovayKitaevDecomposition.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.synthesis.SolovayKitaevDecomposition --- -# SolovayKitaevDecomposition[¶](#solovaykitaevdecomposition "Permalink to this headline") +# SolovayKitaevDecomposition -`SolovayKitaevDecomposition(basic_approximations=None)` +`SolovayKitaevDecomposition(basic_approximations=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Bases: `object` @@ -28,7 +28,7 @@ This class is called recursively by the transpiler pass, which is why it is sepa -`SolovayKitaevDecomposition.find_basic_approximation(sequence)` +`SolovayKitaevDecomposition.find_basic_approximation(sequence)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Finds gate in `self._basic_approximations` that best represents `sequence`. @@ -48,7 +48,7 @@ Gate in basic approximations that is closest to `sequence`. -`SolovayKitaevDecomposition.load_basic_approximations(data)` +`SolovayKitaevDecomposition.load_basic_approximations(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Load basic approximations. @@ -72,7 +72,7 @@ A list of basic approximations as type `GateSequence`. -`SolovayKitaevDecomposition.run(gate_matrix, recursion_degree, return_dag=False, check_input=True)` +`SolovayKitaevDecomposition.run(gate_matrix, recursion_degree, return_dag=False, check_input=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/solovay_kitaev.py "view source code") Run the algorithm. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.SuzukiTrotter.md b/docs/api/qiskit/0.41/qiskit.synthesis.SuzukiTrotter.md index 7f2dd400869..791a53bf568 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.SuzukiTrotter.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.SuzukiTrotter.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.synthesis.SuzukiTrotter --- -# SuzukiTrotter[¶](#suzukitrotter "Permalink to this headline") +# SuzukiTrotter -`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)` +`SuzukiTrotter(order=2, reps=1, insert_barriers=False, cx_structure='chain', atomic_evolution=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Bases: [`qiskit.synthesis.evolution.product_formula.ProductFormula`](qiskit.synthesis.ProductFormula "qiskit.synthesis.evolution.product_formula.ProductFormula") @@ -48,7 +48,7 @@ $$ -`SuzukiTrotter.synthesize(evolution)` +`SuzukiTrotter.synthesize(evolution)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/evolution/suzuki_trotter.py "view source code") Synthesize an `qiskit.circuit.library.PauliEvolutionGate`. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.generate_basic_approximations.md b/docs/api/qiskit/0.41/qiskit.synthesis.generate_basic_approximations.md index 166e04f973a..ede4a1f8478 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.generate_basic_approximations.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.generate_basic_approximations.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.synthesis.generate_basic_approximations --- -# qiskit.synthesis.generate\_basic\_approximations[¶](#qiskit-synthesis-generate-basic-approximations "Permalink to this headline") +# qiskit.synthesis.generate\_basic\_approximations -`generate_basic_approximations(basis_gates, depth, filename=None)` +`generate_basic_approximations(basis_gates, depth, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/discrete_basis/generate_basis_approximations.py "view source code") Generates a list of `GateSequence``s with the gates in ``basic_gates`. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_ag.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_ag.md index e743ada4ecc..7ecda249dd0 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_ag.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_ag.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.synthesis.synth_clifford_ag --- -# qiskit.synthesis.synth\_clifford\_ag[¶](#qiskit-synthesis-synth-clifford-ag "Permalink to this headline") +# qiskit.synthesis.synth\_clifford\_ag -`synth_clifford_ag(clifford)` +`synth_clifford_ag(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_ag.py "view source code") Decompose a Clifford operator into a QuantumCircuit based on Aaronson-Gottesman method. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_bm.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_bm.md index d6d4c643f58..a1d81910e85 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_bm.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_bm.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.synthesis.synth_clifford_bm --- -# qiskit.synthesis.synth\_clifford\_bm[¶](#qiskit-synthesis-synth-clifford-bm "Permalink to this headline") +# qiskit.synthesis.synth\_clifford\_bm -`synth_clifford_bm(clifford)` +`synth_clifford_bm(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_bm.py "view source code") Optimal CX-cost decomposition of a Clifford operator on 2-qubits or 3-qubits into a QuantumCircuit based on Bravyi-Maslov method. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_full.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_full.md index 5ab8c4ee7de..96294f15235 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_full.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_full.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.synthesis.synth_clifford_full --- -# qiskit.synthesis.synth\_clifford\_full[¶](#qiskit-synthesis-synth-clifford-full "Permalink to this headline") +# qiskit.synthesis.synth\_clifford\_full -`synth_clifford_full(clifford, method=None)` +`synth_clifford_full(clifford, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_full.py "view source code") Decompose a Clifford operator into a QuantumCircuit. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_greedy.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_greedy.md index 74cf41c236e..194d1106e23 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_greedy.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_greedy.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.synthesis.synth_clifford_greedy --- -# qiskit.synthesis.synth\_clifford\_greedy[¶](#qiskit-synthesis-synth-clifford-greedy "Permalink to this headline") +# qiskit.synthesis.synth\_clifford\_greedy -`synth_clifford_greedy(clifford)` +`synth_clifford_greedy(clifford)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_greedy.py "view source code") Decompose a Clifford operator into a QuantumCircuit based on the greedy Clifford compiler that is described in Appendix A of Bravyi, Hu, Maslov and Shaydulin. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_layers.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_layers.md index 51798ac1b29..6c2b345a32e 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_layers.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_clifford_layers.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.synthesis.synth_clifford_layers --- -# qiskit.synthesis.synth\_clifford\_layers[¶](#qiskit-synthesis-synth-clifford-layers "Permalink to this headline") +# qiskit.synthesis.synth\_clifford\_layers -`synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, validate=False)` +`synth_clifford_layers(cliff, cx_synth_func=, cz_synth_func=, cx_cz_synth_func=None, validate=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/clifford/clifford_decompose_layers.py "view source code") Synthesis of a Clifford into layers, it provides a similar decomposition to the synthesis described in Lemma 8 of \[1]. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnot_count_full_pmh.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnot_count_full_pmh.md index 842939c14b2..847af28bdbc 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnot_count_full_pmh.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnot_count_full_pmh.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.synthesis.synth_cnot_count_full_pmh --- -# qiskit.synthesis.synth\_cnot\_count\_full\_pmh[¶](#qiskit-synthesis-synth-cnot-count-full-pmh "Permalink to this headline") +# qiskit.synthesis.synth\_cnot\_count\_full\_pmh -`synth_cnot_count_full_pmh(state, section_size=2)` +`synth_cnot_count_full_pmh(state, section_size=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/linear/graysynth.py "view source code") Synthesize linear reversible circuits for all-to-all architecture using Patel, Markov and Hayes method. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnot_depth_line_kms.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnot_depth_line_kms.md index 36f4211c68d..b5568f1424a 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnot_depth_line_kms.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnot_depth_line_kms.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.synthesis.synth_cnot_depth_line_kms --- -# qiskit.synthesis.synth\_cnot\_depth\_line\_kms[¶](#qiskit-synthesis-synth-cnot-depth-line-kms "Permalink to this headline") +# qiskit.synthesis.synth\_cnot\_depth\_line\_kms -`synth_cnot_depth_line_kms(mat)` +`synth_cnot_depth_line_kms(mat)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/linear/linear_depth_lnn.py "view source code") Synthesize linear reversible circuit for linear nearest-neighbor architectures using Kutin, Moulton, Smithline method. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_full.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_full.md index beef270c5d0..c7c9990ec6c 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_full.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_full.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.synthesis.synth_cnotdihedral_full --- -# qiskit.synthesis.synth\_cnotdihedral\_full[¶](#qiskit-synthesis-synth-cnotdihedral-full "Permalink to this headline") +# qiskit.synthesis.synth\_cnotdihedral\_full -`synth_cnotdihedral_full(elem)` +`synth_cnotdihedral_full(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_full.py "view source code") Decompose a CNOTDihedral element into a QuantumCircuit. For N \<= 2 qubits this is based on optimal CX cost decomposition from reference \[1]. For N > 2 qubits this is done using the general non-optimal compilation routine from reference \[2]. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_general.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_general.md index 84676664f8a..24d2abc96ce 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_general.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_general.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.synthesis.synth_cnotdihedral_general --- -# qiskit.synthesis.synth\_cnotdihedral\_general[¶](#qiskit-synthesis-synth-cnotdihedral-general "Permalink to this headline") +# qiskit.synthesis.synth\_cnotdihedral\_general -`synth_cnotdihedral_general(elem)` +`synth_cnotdihedral_general(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_general.py "view source code") Decompose a CNOTDihedral element into a QuantumCircuit. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_two_qubits.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_two_qubits.md index 4bf9982b5d5..c8537d21d00 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_two_qubits.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_cnotdihedral_two_qubits.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.synthesis.synth_cnotdihedral_two_qubits --- -# qiskit.synthesis.synth\_cnotdihedral\_two\_qubits[¶](#qiskit-synthesis-synth-cnotdihedral-two-qubits "Permalink to this headline") +# qiskit.synthesis.synth\_cnotdihedral\_two\_qubits -`synth_cnotdihedral_two_qubits(elem)` +`synth_cnotdihedral_two_qubits(elem)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/cnotdihedral/cnotdihedral_decompose_two_qubits.py "view source code") Decompose a CNOTDihedral element on a single qubit and two qubits into a QuantumCircuit. This decomposition has an optimal number of CX gates. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_acg.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_acg.md index 0b2ebff56ce..81998640617 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_acg.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_acg.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.synthesis.synth_permutation_acg --- -# qiskit.synthesis.synth\_permutation\_acg[¶](#qiskit-synthesis-synth-permutation-acg "Permalink to this headline") +# qiskit.synthesis.synth\_permutation\_acg -`synth_permutation_acg(pattern)` +`synth_permutation_acg(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using the Alon, Chung, Graham method. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_basic.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_basic.md index 4a0edd44206..bfee99f7bb3 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_basic.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_basic.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.synthesis.synth_permutation_basic --- -# qiskit.synthesis.synth\_permutation\_basic[¶](#qiskit-synthesis-synth-permutation-basic "Permalink to this headline") +# qiskit.synthesis.synth\_permutation\_basic -`synth_permutation_basic(pattern)` +`synth_permutation_basic(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_full.py "view source code") Synthesize a permutation circuit for a fully-connected architecture using sorting. diff --git a/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_depth_lnn_kms.md b/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_depth_lnn_kms.md index 66bdee36f56..ddbf659d603 100644 --- a/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_depth_lnn_kms.md +++ b/docs/api/qiskit/0.41/qiskit.synthesis.synth_permutation_depth_lnn_kms.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.synthesis.synth_permutation_depth_lnn_kms --- -# qiskit.synthesis.synth\_permutation\_depth\_lnn\_kms[¶](#qiskit-synthesis-synth-permutation-depth-lnn-kms "Permalink to this headline") +# qiskit.synthesis.synth\_permutation\_depth\_lnn\_kms -`synth_permutation_depth_lnn_kms(pattern)` +`synth_permutation_depth_lnn_kms(pattern)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/synthesis/permutation/permutation_lnn.py "view source code") Synthesize a permutation circuit for a linear nearest-neighbor architecture using the Kutin, Moulton, Smithline method. diff --git a/docs/api/qiskit/0.41/qiskit.tools.backend_monitor.md b/docs/api/qiskit/0.41/qiskit.tools.backend_monitor.md index 11f049f91e7..8f375df262c 100644 --- a/docs/api/qiskit/0.41/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.41/qiskit.tools.backend_monitor.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.tools.backend_monitor --- -# qiskit.tools.backend\_monitor[¶](#qiskit-tools-backend-monitor "Permalink to this headline") +# qiskit.tools.backend\_monitor -`backend_monitor(backend)` +`backend_monitor(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/overview.py "view source code") Monitor a single IBMQ backend. diff --git a/docs/api/qiskit/0.41/qiskit.tools.backend_overview.md b/docs/api/qiskit/0.41/qiskit.tools.backend_overview.md index 896037fb5d0..d3c6eca514f 100644 --- a/docs/api/qiskit/0.41/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.41/qiskit.tools.backend_overview.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.tools.backend_overview --- -# qiskit.tools.backend\_overview[¶](#qiskit-tools-backend-overview "Permalink to this headline") +# qiskit.tools.backend\_overview -`backend_overview()` +`backend_overview()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/overview.py "view source code") Gives overview information on all the IBMQ backends that are available. diff --git a/docs/api/qiskit/0.41/qiskit.tools.events.TextProgressBar.md b/docs/api/qiskit/0.41/qiskit.tools.events.TextProgressBar.md index 4cb77bf39d7..ffe80433889 100644 --- a/docs/api/qiskit/0.41/qiskit.tools.events.TextProgressBar.md +++ b/docs/api/qiskit/0.41/qiskit.tools.events.TextProgressBar.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.tools.events.TextProgressBar --- -# TextProgressBar[¶](#textprogressbar "Permalink to this headline") +# TextProgressBar -`TextProgressBar(output_handler=None)` +`TextProgressBar(output_handler=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") Bases: `qiskit.tools.events.progressbar.BaseProgressBar` @@ -70,7 +70,7 @@ Run when progress bar has completed. -`TextProgressBar.start(iterations)` +`TextProgressBar.start(iterations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") Start the progress bar. @@ -134,7 +134,7 @@ Unsubscribe a pair event-callback, so the callback will not be called anymore wh -`TextProgressBar.update(n)` +`TextProgressBar.update(n)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/events/progressbar.py "view source code") Update status of progress bar. diff --git a/docs/api/qiskit/0.41/qiskit.tools.job_monitor.md b/docs/api/qiskit/0.41/qiskit.tools.job_monitor.md index d5a8f55597e..c348440c722 100644 --- a/docs/api/qiskit/0.41/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.41/qiskit.tools.job_monitor.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.tools.job_monitor --- -# qiskit.tools.job\_monitor[¶](#qiskit-tools-job-monitor "Permalink to this headline") +# qiskit.tools.job\_monitor -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')` +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='utf-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. diff --git a/docs/api/qiskit/0.41/qiskit.tools.parallel_map.md b/docs/api/qiskit/0.41/qiskit.tools.parallel_map.md index 5060c1808cf..067b5e228fb 100644 --- a/docs/api/qiskit/0.41/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.41/qiskit.tools.parallel_map.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.tools.parallel_map --- -# qiskit.tools.parallel\_map[¶](#qiskit-tools-parallel-map "Permalink to this headline") +# qiskit.tools.parallel\_map -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)` +`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/tools/parallel.py "view source code") Parallel execution of a mapping of values to the function task. This is functionally equivalent to: diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.41/qiskit.transpiler.AnalysisPass.md index 711885f009f..01e7684f560 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.AnalysisPass.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.AnalysisPass --- -# AnalysisPass[¶](#analysispass "Permalink to this headline") +# AnalysisPass -`AnalysisPass(*args, **kwargs)` +`AnalysisPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.ConditionalController.md b/docs/api/qiskit/0.41/qiskit.transpiler.ConditionalController.md index 6ed1abc8c53..f32b7fd8b88 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.ConditionalController.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.ConditionalController.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.ConditionalController --- -# ConditionalController[¶](#conditionalcontroller "Permalink to this headline") +# ConditionalController -`ConditionalController(passes, options=None, condition=None, **partial_controller)` +`ConditionalController(passes, options=None, condition=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.41/qiskit.transpiler.CouplingMap.md index 292dd7c1a73..c57c7beaa47 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.CouplingMap.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.CouplingMap --- -# CouplingMap[¶](#couplingmap "Permalink to this headline") +# CouplingMap -`CouplingMap(couplinglist=None, description=None)` +`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Bases: `object` @@ -31,7 +31,7 @@ Create coupling graph. By default, the generated coupling has no nodes. -`CouplingMap.add_edge(src, dst)` +`CouplingMap.add_edge(src, dst)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Add directed edge to coupling graph. @@ -41,7 +41,7 @@ src (int): source physical qubit dst (int): destination physical qubit -`CouplingMap.add_physical_qubit(physical_qubit)` +`CouplingMap.add_physical_qubit(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Add a physical qubit to the coupling graph as a node. @@ -55,7 +55,7 @@ physical\_qubit (int): An integer representing a physical qubit. -`CouplingMap.compute_distance_matrix()` +`CouplingMap.compute_distance_matrix()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Compute the full distance matrix on pairs of nodes. @@ -65,7 +65,7 @@ The distance map self.\_dist\_matrix is computed from the graph using all\_pairs -`CouplingMap.distance(physical_qubit1, physical_qubit2)` +`CouplingMap.distance(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Returns the undirected distance between physical\_qubit1 and physical\_qubit2. @@ -90,7 +90,7 @@ int -`CouplingMap.draw()` +`CouplingMap.draw()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Draws the coupling map. @@ -108,7 +108,7 @@ PIL.Image -`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)` +`classmethod CouplingMap.from_full(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a fully connected coupling map on n qubits. @@ -120,7 +120,7 @@ Return a fully connected coupling map on n qubits. -`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)` +`classmethod CouplingMap.from_grid(num_rows, num_columns, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. @@ -132,7 +132,7 @@ Return a coupling map of qubits connected on a grid of num\_rows x num\_columns. -`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)` +`classmethod CouplingMap.from_heavy_hex(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a heavy hexagon graph coupling map. @@ -157,7 +157,7 @@ A heavy hex coupling graph -`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)` +`classmethod CouplingMap.from_heavy_square(distance, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a heavy square graph coupling map. @@ -182,7 +182,7 @@ A heavy square coupling graph -`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)` +`classmethod CouplingMap.from_hexagonal_lattice(rows, cols, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a hexagonal lattice graph coupling map. @@ -204,7 +204,7 @@ A hexagonal lattice coupling graph -`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)` +`classmethod CouplingMap.from_line(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected in a line. @@ -216,7 +216,7 @@ Return a coupling map of n qubits connected in a line. -`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)` +`classmethod CouplingMap.from_ring(num_qubits, bidirectional=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a coupling map of n qubits connected to each of their neighbors in a ring. @@ -228,7 +228,7 @@ Return a coupling map of n qubits connected to each of their neighbors in a ring -`CouplingMap.get_edges()` +`CouplingMap.get_edges()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Gets the list of edges in the coupling graph. @@ -244,7 +244,7 @@ Tuple(int,int) -`CouplingMap.is_connected()` +`CouplingMap.is_connected()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Test if the graph is connected. @@ -254,7 +254,7 @@ Return True if connected, False otherwise -`CouplingMap.largest_connected_component()` +`CouplingMap.largest_connected_component()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a set of qubits in the largest connected component. @@ -262,7 +262,7 @@ Return a set of qubits in the largest connected component. -`CouplingMap.make_symmetric()` +`CouplingMap.make_symmetric()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Convert uni-directional edges into bi-directional. @@ -270,7 +270,7 @@ Convert uni-directional edges into bi-directional. -`CouplingMap.neighbors(physical_qubit)` +`CouplingMap.neighbors(physical_qubit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return the nearest neighbors of a physical qubit. @@ -280,7 +280,7 @@ Directionality matters, i.e. a neighbor must be reachable by going one hop in th -`CouplingMap.reduce(mapping)` +`CouplingMap.reduce(mapping)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Returns a reduced coupling map that corresponds to the subgraph of qubits selected in the mapping. @@ -304,7 +304,7 @@ A reduced coupling\_map for the selected qubits. -`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)` +`CouplingMap.shortest_undirected_path(physical_qubit1, physical_qubit2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Returns the shortest undirected path between physical\_qubit1 and physical\_qubit2. @@ -329,7 +329,7 @@ List -`CouplingMap.size()` +`CouplingMap.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return the number of physical qubits in this graph. @@ -337,7 +337,7 @@ Return the number of physical qubits in this graph. -`CouplingMap.subgraph(nodelist)` +`CouplingMap.subgraph(nodelist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/coupling.py "view source code") Return a CouplingMap object for a subgraph of self. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.DoWhileController.md b/docs/api/qiskit/0.41/qiskit.transpiler.DoWhileController.md index 6f9d7008f13..a6be40f4ed4 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.DoWhileController.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.DoWhileController.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.DoWhileController --- -# DoWhileController[¶](#dowhilecontroller "Permalink to this headline") +# DoWhileController -`DoWhileController(passes, options=None, do_while=None, **partial_controller)` +`DoWhileController(passes, options=None, do_while=None, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Bases: [`qiskit.transpiler.runningpassmanager.FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.runningpassmanager.FlowController") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.41/qiskit.transpiler.FencedDAGCircuit.md index 48fd094c195..61563412856 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.FencedDAGCircuit.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.FencedDAGCircuit --- -# FencedDAGCircuit[¶](#fenceddagcircuit "Permalink to this headline") +# FencedDAGCircuit -`FencedDAGCircuit(dag_circuit_instance)` +`FencedDAGCircuit(dag_circuit_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.41/qiskit.transpiler.FencedPropertySet.md index e131159b4ba..d1cebbf5482 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.FencedPropertySet.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.FencedPropertySet --- -# FencedPropertySet[¶](#fencedpropertyset "Permalink to this headline") +# FencedPropertySet -`FencedPropertySet(property_set_instance)` +`FencedPropertySet(property_set_instance)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/fencedobjs.py "view source code") Bases: `qiskit.transpiler.fencedobjs.FencedObject` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.41/qiskit.transpiler.FlowController.md index 736f73bdd06..5f0af7f1dbd 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.FlowController.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.FlowController --- -# FlowController[¶](#flowcontroller "Permalink to this headline") +# FlowController -`FlowController(passes, options, **partial_controller)` +`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ This class is a base class for multiple types of working list. When you iterate -`classmethod FlowController.add_flow_controller(name, controller)` +`classmethod FlowController.add_flow_controller(name, controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Adds a flow controller. @@ -37,7 +37,7 @@ Adds a flow controller. -`classmethod FlowController.controller_factory(passes, options, **partial_controller)` +`classmethod FlowController.controller_factory(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Constructs a flow controller based on the partially evaluated controller arguments. @@ -63,7 +63,7 @@ A FlowController instance. -`FlowController.dump_passes()` +`FlowController.dump_passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Fetches the passes added to this flow controller. @@ -79,7 +79,7 @@ dict -`classmethod FlowController.remove_flow_controller(name)` +`classmethod FlowController.remove_flow_controller(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/runningpassmanager.py "view source code") Removes a flow controller. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.41/qiskit.transpiler.InstructionDurations.md index b564b656c6f..0ee681ef048 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.InstructionDurations.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.InstructionDurations --- -# InstructionDurations[¶](#instructiondurations "Permalink to this headline") +# InstructionDurations -`InstructionDurations(instruction_durations=None, dt=None)` +`InstructionDurations(instruction_durations=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ It stores durations (gate lengths) and dt to be used at the scheduling stage of -`classmethod InstructionDurations.from_backend(backend)` +`classmethod InstructionDurations.from_backend(backend)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Construct an [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. @@ -48,7 +48,7 @@ The InstructionDurations constructed from backend. -`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)` +`InstructionDurations.get(inst, qubits, unit='dt', parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Get the duration of the instruction with the name, qubits, and parameters. @@ -77,7 +77,7 @@ float|int -`InstructionDurations.units_used()` +`InstructionDurations.units_used()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Get the set of all units used in this instruction durations. @@ -93,7 +93,7 @@ Set of units used in this instruction durations. -`InstructionDurations.update(inst_durations, dt=None)` +`InstructionDurations.update(inst_durations, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/instruction_durations.py "view source code") Update self with inst\_durations (inst\_durations overwrite self). diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.InstructionProperties.md b/docs/api/qiskit/0.41/qiskit.transpiler.InstructionProperties.md index 262cc494779..e70f16f17b4 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.InstructionProperties.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.InstructionProperties.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.InstructionProperties --- -# InstructionProperties[¶](#instructionproperties "Permalink to this headline") +# InstructionProperties -`InstructionProperties(duration=None, error=None, calibration=None)` +`InstructionProperties(duration=None, error=None, calibration=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.41/qiskit.transpiler.Layout.md index df357b9a215..aec70a2f0a1 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.Layout.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.Layout --- -# Layout[¶](#layout "Permalink to this headline") +# Layout -`Layout(input_dict=None)` +`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Bases: `object` @@ -24,7 +24,7 @@ construct a Layout from a bijective dictionary, mapping virtual qubits to physic -`Layout.add(virtual_bit, physical_bit=None)` +`Layout.add(virtual_bit, physical_bit=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Adds a map element between bit and physical\_bit. If physical\_bit is not defined, bit will be mapped to a new physical bit. @@ -37,7 +37,7 @@ Adds a map element between bit and physical\_bit. If physical\_bit is not define -`Layout.add_register(reg)` +`Layout.add_register(reg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Adds at the end physical\_qubits that map each bit in reg. @@ -49,7 +49,7 @@ Adds at the end physical\_qubits that map each bit in reg. -`Layout.combine_into_edge_map(another_layout)` +`Layout.combine_into_edge_map(another_layout)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Combines self and another\_layout into an “edge map”. @@ -84,7 +84,7 @@ dict -`Layout.copy()` +`Layout.copy()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Returns a copy of a Layout instance. @@ -92,7 +92,7 @@ Returns a copy of a Layout instance. -`Layout.from_dict(input_dict)` +`Layout.from_dict(input_dict)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Populates a Layout from a dictionary. @@ -128,7 +128,7 @@ Can be written more concisely as follows: -`static Layout.from_intlist(int_list, *qregs)` +`static Layout.from_intlist(int_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). @@ -153,7 +153,7 @@ The corresponding Layout object. -`static Layout.from_qubit_list(qubit_list, *qregs)` +`static Layout.from_qubit_list(qubit_list, *qregs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Populates a Layout from a list containing virtual qubits, Qubit or None. @@ -178,7 +178,7 @@ the corresponding Layout object -`static Layout.generate_trivial_layout(*regs)` +`static Layout.generate_trivial_layout(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. @@ -198,7 +198,7 @@ A layout with all the regs in the given order. -`Layout.get_physical_bits()` +`Layout.get_physical_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are physical (qu)bits and the values are virtual (qu)bits. @@ -206,7 +206,7 @@ Returns the dictionary where the keys are physical (qu)bits and the values are v -`Layout.get_registers()` +`Layout.get_registers()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegister(3, ‘qr1’)] :returns: A set of Registers in the layout :rtype: Set @@ -214,7 +214,7 @@ Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegi -`Layout.get_virtual_bits()` +`Layout.get_virtual_bits()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Returns the dictionary where the keys are virtual (qu)bits and the values are physical (qu)bits. @@ -222,7 +222,7 @@ Returns the dictionary where the keys are virtual (qu)bits and the values are ph -`static Layout.order_based_on_type(value1, value2)` +`static Layout.order_based_on_type(value1, value2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") decides which one is physical/virtual based on the type. Returns (virtual, physical) @@ -230,7 +230,7 @@ decides which one is physical/virtual based on the type. Returns (virtual, physi -`Layout.reorder_bits(bits)` +`Layout.reorder_bits(bits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Given an ordered list of bits, reorder them according to this layout. @@ -252,7 +252,7 @@ List -`Layout.swap(left, right)` +`Layout.swap(left, right)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/layout.py "view source code") Swaps the map between left and right. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.41/qiskit.transpiler.PassManager.md index e244b013bc9..6e348546fac 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.PassManager.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.PassManager --- -# PassManager[¶](#passmanager "Permalink to this headline") +# PassManager -`PassManager(passes=None, max_iteration=1000)` +`PassManager(passes=None, max_iteration=1000)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Bases: `object` @@ -29,7 +29,7 @@ Initialize an empty PassManager object (with no passes scheduled). -`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)` +`PassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -55,7 +55,7 @@ Append a Pass Set to the schedule of passes. -`PassManager.draw(filename=None, style=None, raw=False)` +`PassManager.draw(filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Draw the pass manager. @@ -83,7 +83,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`PassManager.passes()` +`PassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -99,7 +99,7 @@ A list of pass sets, as defined in `append()`. -`PassManager.remove(index)` +`PassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -119,7 +119,7 @@ Removes a particular pass in the scheduler. -`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` +`PassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -146,7 +146,7 @@ Replace a particular pass in the scheduler. -`PassManager.run(circuits, output_name=None, callback=None)` +`PassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. @@ -194,7 +194,7 @@ The transformed circuit(s). -`PassManager.to_flow_controller()` +`PassManager.to_flow_controller()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Linearize this manager into a single [`FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.FlowController"), so that it can be nested inside another [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager"). diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.41/qiskit.transpiler.PassManagerConfig.md index 7c3eb0305c4..2a39e258f7f 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.PassManagerConfig.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.PassManagerConfig --- -# PassManagerConfig[¶](#passmanagerconfig "Permalink to this headline") +# PassManagerConfig -`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)` +`PassManagerConfig(initial_layout=None, basis_gates=None, inst_map=None, coupling_map=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, instruction_durations=None, backend_properties=None, approximation_degree=None, seed_transpiler=None, timing_constraints=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, target=None, hls_config=None, init_method=None, optimization_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager_config.py "view source code") Bases: `object` @@ -45,7 +45,7 @@ Initialize a PassManagerConfig object -`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)` +`classmethod PassManagerConfig.from_backend(backend, **pass_manager_options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager_config.py "view source code") Construct a configuration based on a backend and user input. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.41/qiskit.transpiler.PropertySet.md index c40352c10a9..7b3bf1e21fb 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.PropertySet.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.PropertySet --- -# PropertySet[¶](#propertyset "Permalink to this headline") +# PropertySet -`PropertySet` +`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/propertyset.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.StagedPassManager.md b/docs/api/qiskit/0.41/qiskit.transpiler.StagedPassManager.md index ed18d504208..fb099b38cf3 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.StagedPassManager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.StagedPassManager.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.StagedPassManager --- -# StagedPassManager[¶](#stagedpassmanager "Permalink to this headline") +# StagedPassManager -`StagedPassManager(stages=None, **kwargs)` +`StagedPassManager(stages=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Bases: [`qiskit.transpiler.passmanager.PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.passmanager.PassManager") @@ -51,7 +51,7 @@ Initialize a new StagedPassManager object -`StagedPassManager.append(passes, max_iteration=None, **flow_controller_conditions)` +`StagedPassManager.append(passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Append a Pass Set to the schedule of passes. @@ -105,7 +105,7 @@ Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassMan -`StagedPassManager.passes()` +`StagedPassManager.passes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Return a list structure of the appended passes and its options. @@ -121,7 +121,7 @@ A list of pass sets, as defined in `append()`. -`StagedPassManager.remove(index)` +`StagedPassManager.remove(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Removes a particular pass in the scheduler. @@ -141,7 +141,7 @@ Removes a particular pass in the scheduler. -`StagedPassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)` +`StagedPassManager.replace(index, passes, max_iteration=None, **flow_controller_conditions)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Replace a particular pass in the scheduler. @@ -168,7 +168,7 @@ Replace a particular pass in the scheduler. -`StagedPassManager.run(circuits, output_name=None, callback=None)` +`StagedPassManager.run(circuits, output_name=None, callback=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passmanager.py "view source code") Run all the passes on the specified `circuits`. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.Target.md b/docs/api/qiskit/0.41/qiskit.transpiler.Target.md index b917c1a9b32..83ad12c4808 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.Target.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.Target.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.Target --- -# Target[¶](#target "Permalink to this headline") +# Target -`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1, qubit_properties=None)` +`Target(description=None, num_qubits=0, dt=None, granularity=1, min_length=1, pulse_alignment=1, aquire_alignment=1, qubit_properties=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Bases: `collections.abc.Mapping` @@ -95,7 +95,7 @@ Create a new Target object -`Target.add_instruction(instruction, properties=None, name=None)` +`Target.add_instruction(instruction, properties=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Add a new instruction to the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") @@ -136,7 +136,7 @@ Will add a [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGa -`Target.build_coupling_map(two_q_gate=None)` +`Target.build_coupling_map(two_q_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get a [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") from this target. @@ -165,7 +165,7 @@ for this target. If there are no connectivity constraints in the target this wil -`Target.durations()` +`Target.durations()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get an InstructionDurations object from the target @@ -189,7 +189,7 @@ target -`Target.get_non_global_operation_names(strict_direction=False)` +`Target.get_non_global_operation_names(strict_direction=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Return the non-global operation names for the target @@ -211,7 +211,7 @@ List\[str] -`Target.instruction_properties(index)` +`Target.instruction_properties(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the instruction properties for a specific instruction tuple @@ -251,7 +251,7 @@ The instruction properties for the specified instruction tuple -`Target.instruction_schedule_map()` +`Target.instruction_schedule_map()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Return an [`InstructionScheduleMap`](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap") for the instructions in the target with a pulse schedule defined. @@ -267,7 +267,7 @@ The instruction schedule map for the instructions in this target with a pulse sc -`Target.instruction_supported(operation_name=None, qargs=None, operation_class=None, parameters=None)` +`Target.instruction_supported(operation_name=None, qargs=None, operation_class=None, parameters=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Return whether the instruction (operation + qubits) is supported by the target @@ -308,19 +308,19 @@ bool -`Target.items() → a set-like object providing a view on D's items` +`Target.items() → a set-like object providing a view on D's items`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") ### keys -`Target.keys() → a set-like object providing a view on D's keys` +`Target.keys() → a set-like object providing a view on D's keys`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") ### operation\_from\_name -`Target.operation_from_name(instruction)` +`Target.operation_from_name(instruction)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the operation class object for a given name @@ -340,7 +340,7 @@ The Instruction instance corresponding to the name. This also can also be the cl -`Target.operation_names_for_qargs(qargs)` +`Target.operation_names_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the operation names for a specified qargs tuple @@ -364,7 +364,7 @@ set -`Target.operations_for_qargs(qargs)` +`Target.operations_for_qargs(qargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the operation class object for a specified qargs tuple @@ -388,7 +388,7 @@ list -`Target.qargs_for_operation_name(operation)` +`Target.qargs_for_operation_name(operation)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get the qargs for a given operation name @@ -408,7 +408,7 @@ set -`Target.timing_constraints()` +`Target.timing_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Get an `TimingConstraints` object from the target @@ -424,7 +424,7 @@ TimingConstraints -`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)` +`Target.update_from_instruction_schedule_map(inst_map, inst_name_map=None, error_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Update the target from an instruction schedule map. @@ -463,7 +463,7 @@ If the input instruction schedule map contains new instructions not in the targe -`Target.update_instruction_properties(instruction, qargs, properties)` +`Target.update_instruction_properties(instruction, qargs, properties)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") Update the property object for an instruction qarg pair already in the Target @@ -481,7 +481,7 @@ Update the property object for an instruction qarg pair already in the Target -`Target.values() → an object providing a view on D's values` +`Target.values() → an object providing a view on D's values`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/target.py "view source code") ## Attributes diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.41/qiskit.transpiler.TransformationPass.md index c908d8a4285..b3311265ad7 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.TransformationPass.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.TransformationPass --- -# TransformationPass[¶](#transformationpass "Permalink to this headline") +# TransformationPass -`TransformationPass(*args, **kwargs)` +`TransformationPass(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/basepasses.py "view source code") Bases: `qiskit.transpiler.basepasses.BasePass` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerAccessError.md index b4e475c2414..29397d4512e 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerAccessError.md @@ -6,11 +6,11 @@ python_api_type: exception python_api_name: qiskit.transpiler.TranspilerAccessError --- -# qiskit.transpiler.TranspilerAccessError[¶](#qiskit-transpiler-transpileraccesserror "Permalink to this headline") +# qiskit.transpiler.TranspilerAccessError -`TranspilerAccessError(*message)` +`TranspilerAccessError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/exceptions.py "view source code") DEPRECATED: Exception of access error in the transpiler passes. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerError.md index eea94e52116..b7b747e5dac 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.TranspilerError.md @@ -6,11 +6,11 @@ python_api_type: exception python_api_name: qiskit.transpiler.TranspilerError --- -# qiskit.transpiler.TranspilerError[¶](#qiskit-transpiler-transpilererror "Permalink to this headline") +# qiskit.transpiler.TranspilerError -`TranspilerError(*message)` +`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ACGSynthesisPermutation.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ACGSynthesisPermutation.md index ee53eb71f1a..59f494ffa32 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ACGSynthesisPermutation.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ACGSynthesisPermutation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.ACGSynthesisPermutation --- -# ACGSynthesisPermutation[¶](#acgsynthesispermutation "Permalink to this headline") +# ACGSynthesisPermutation -`ACGSynthesisPermutation` +`ACGSynthesisPermutation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") @@ -42,7 +42,7 @@ print(f"acg: {qct.size() = }, {qct.depth() = }") -`ACGSynthesisPermutation.run(high_level_object, **options)` +`ACGSynthesisPermutation.run(high_level_object, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Run synthesis for the given Permutation. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPSchedule.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPSchedule.md index 3a812ff8638..2e3b1ecf22a 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPSchedule.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.ALAPSchedule --- -# ALAPSchedule[¶](#alapschedule "Permalink to this headline") +# ALAPSchedule -`ALAPSchedule(*args, **kwargs)` +`ALAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ALAPSchedule.run(dag)` +`ALAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPScheduleAnalysis.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPScheduleAnalysis.md index 3db3b3d79e3..c7a5f92d706 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ALAPScheduleAnalysis.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.ALAPScheduleAnalysis --- -# ALAPScheduleAnalysis[¶](#alapscheduleanalysis "Permalink to this headline") +# ALAPScheduleAnalysis -`ALAPScheduleAnalysis(durations)` +`ALAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` @@ -38,7 +38,7 @@ Return the name of the pass. -`ALAPScheduleAnalysis.run(dag)` +`ALAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/alap.py "view source code") Run the ALAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPSchedule.md index 4a232ae34be..46d46e4b721 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPSchedule.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.ASAPSchedule --- -# ASAPSchedule[¶](#asapschedule "Permalink to this headline") +# ASAPSchedule -`ASAPSchedule(*args, **kwargs)` +`ASAPSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.base_scheduler.BaseSchedulerTransform` @@ -44,7 +44,7 @@ Return the name of the pass. -`ASAPSchedule.run(dag)` +`ASAPSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPScheduleAnalysis.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPScheduleAnalysis.md index be50658d6e6..f5aa9f097b4 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPScheduleAnalysis.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ASAPScheduleAnalysis.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.ASAPScheduleAnalysis --- -# ASAPScheduleAnalysis[¶](#asapscheduleanalysis "Permalink to this headline") +# ASAPScheduleAnalysis -`ASAPScheduleAnalysis(durations)` +`ASAPScheduleAnalysis(durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.scheduling.base_scheduler.BaseScheduler` @@ -38,7 +38,7 @@ Return the name of the pass. -`ASAPScheduleAnalysis.run(dag)` +`ASAPScheduleAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/asap.py "view source code") Run the ASAPSchedule pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.AlignMeasures.md index 820ca90e925..0b78abab53e 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.AlignMeasures.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.AlignMeasures --- -# AlignMeasures[¶](#alignmeasures "Permalink to this headline") +# AlignMeasures -`AlignMeasures(alignment=1)` +`AlignMeasures(alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -74,7 +74,7 @@ Return the name of the pass. -`AlignMeasures.run(dag)` +`AlignMeasures.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/align_measures.py "view source code") Run the measurement alignment pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ApplyLayout.md index f2c4c8f92b0..8cf3523dd09 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ApplyLayout.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.ApplyLayout --- -# ApplyLayout[¶](#applylayout "Permalink to this headline") +# ApplyLayout -`ApplyLayout(*args, **kwargs)` +`ApplyLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`ApplyLayout.run(dag)` +`ApplyLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/apply_layout.py "view source code") Run the ApplyLayout pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BIPMapping.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BIPMapping.md index 8cbba98cd22..32439b51fa6 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BIPMapping.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BIPMapping.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.BIPMapping --- -# BIPMapping[¶](#bipmapping "Permalink to this headline") +# BIPMapping -`BIPMapping(*args, **kwargs)` +`BIPMapping(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -83,7 +83,7 @@ Return the name of the pass. -`BIPMapping.run(dag)` +`BIPMapping.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/bip_mapping.py "view source code") Run the BIPMapping pass on dag, assuming the number of virtual qubits (defined in dag) and the number of physical qubits (defined in coupling\_map) are the same. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index 42768bf8bf5..69e1d864cd7 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements --- -# BarrierBeforeFinalMeasurements[¶](#barrierbeforefinalmeasurements "Permalink to this headline") +# BarrierBeforeFinalMeasurements -`BarrierBeforeFinalMeasurements(*args, **kwargs)` +`BarrierBeforeFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`BarrierBeforeFinalMeasurements.run(dag)` +`BarrierBeforeFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/barrier_before_final_measurements.py "view source code") Run the BarrierBeforeFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSwap.md index d9b746fb3df..990f47be323 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSwap.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.BasicSwap --- -# BasicSwap[¶](#basicswap "Permalink to this headline") +# BasicSwap -`BasicSwap(*args, **kwargs)` +`BasicSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`BasicSwap.run(dag)` +`BasicSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/basic_swap.py "view source code") Run the BasicSwap pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSynthesisPermutation.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSynthesisPermutation.md index 6419ad44998..232c3735abe 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSynthesisPermutation.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasicSynthesisPermutation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.BasicSynthesisPermutation --- -# BasicSynthesisPermutation[¶](#basicsynthesispermutation "Permalink to this headline") +# BasicSynthesisPermutation -`BasicSynthesisPermutation` +`BasicSynthesisPermutation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") @@ -42,7 +42,7 @@ print(f"basic: {qct.size() = }, {qct.depth() = }") -`BasicSynthesisPermutation.run(high_level_object, **options)` +`BasicSynthesisPermutation.run(high_level_object, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Run synthesis for the given Permutation. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasisTranslator.md index 2f56de4e4a5..c1903025a90 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.BasisTranslator.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.BasisTranslator --- -# BasisTranslator[¶](#basistranslator "Permalink to this headline") +# BasisTranslator -`BasisTranslator(*args, **kwargs)` +`BasisTranslator(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -51,7 +51,7 @@ Return the name of the pass. -`BasisTranslator.run(dag)` +`BasisTranslator.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/basis_translator.py "view source code") Translate an input DAGCircuit to the target basis. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CSPLayout.md index 4251a571b1a..e1799c68b4d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CSPLayout.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.CSPLayout --- -# CSPLayout[¶](#csplayout "Permalink to this headline") +# CSPLayout -`CSPLayout(*args, **kwargs)` +`CSPLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/csp_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -47,7 +47,7 @@ Return the name of the pass. -`CSPLayout.run(dag)` +`CSPLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/csp_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXCancellation.md index 3df7081282d..c6da41a4cb8 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXCancellation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.CXCancellation --- -# CXCancellation[¶](#cxcancellation "Permalink to this headline") +# CXCancellation -`CXCancellation(*args, **kwargs)` +`CXCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`CXCancellation.run(dag)` +`CXCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/cx_cancellation.py "view source code") Run the CXCancellation pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXDirection.md index cc9da6ad014..4f5b996a7bd 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CXDirection.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.CXDirection --- -# CXDirection[¶](#cxdirection "Permalink to this headline") +# CXDirection -`CXDirection(*args, **kwargs)` +`CXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/cx_direction.py "view source code") Bases: [`qiskit.transpiler.passes.utils.gate_direction.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.utils.gate_direction.GateDirection") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckCXDirection.md index 976ce5ca086..6a13f74c626 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckCXDirection.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.CheckCXDirection --- -# CheckCXDirection[¶](#checkcxdirection "Permalink to this headline") +# CheckCXDirection -`CheckCXDirection(*args, **kwargs)` +`CheckCXDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_cx_direction.py "view source code") Bases: [`qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.utils.check_gate_direction.CheckGateDirection") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckGateDirection.md index 1ad26ce57b1..c0d427193ff 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckGateDirection.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.CheckGateDirection --- -# CheckGateDirection[¶](#checkgatedirection "Permalink to this headline") +# CheckGateDirection -`CheckGateDirection(*args, **kwargs)` +`CheckGateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`CheckGateDirection.run(dag)` +`CheckGateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_gate_direction.py "view source code") Run the CheckGateDirection pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckMap.md index 7352358736d..734b1c13232 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CheckMap.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.CheckMap --- -# CheckMap[¶](#checkmap "Permalink to this headline") +# CheckMap -`CheckMap(*args, **kwargs)` +`CheckMap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_map.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`CheckMap.run(dag)` +`CheckMap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/check_map.py "view source code") Run the CheckMap pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect1qRuns.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect1qRuns.md index d229af4dea4..96b384f9e91 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect1qRuns.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect1qRuns.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.Collect1qRuns --- -# Collect1qRuns[¶](#collect1qruns "Permalink to this headline") +# Collect1qRuns -`Collect1qRuns(*args, **kwargs)` +`Collect1qRuns(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect1qRuns.run(dag)` +`Collect1qRuns.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_1q_runs.py "view source code") Run the Collect1qBlocks pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect2qBlocks.md index bab4240279b..39e06123f91 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Collect2qBlocks.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.Collect2qBlocks --- -# Collect2qBlocks[¶](#collect2qblocks "Permalink to this headline") +# Collect2qBlocks -`Collect2qBlocks(*args, **kwargs)` +`Collect2qBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`Collect2qBlocks.run(dag)` +`Collect2qBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_2q_blocks.py "view source code") Run the Collect2qBlocks pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectAndCollapse.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectAndCollapse.md index 3cf0e432f63..28504c2a6a6 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectAndCollapse.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectAndCollapse.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.CollectAndCollapse --- -# CollectAndCollapse[¶](#collectandcollapse "Permalink to this headline") +# CollectAndCollapse -`CollectAndCollapse(*args, **kwargs)` +`CollectAndCollapse(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_and_collapse.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`CollectAndCollapse.run(dag)` +`CollectAndCollapse.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_and_collapse.py "view source code") Run the CollectLinearFunctions pass on dag. :param dag: the DAG to be optimized. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectCliffords.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectCliffords.md index 35547ae1ef8..95bfe86f3e7 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectCliffords.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectCliffords.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.CollectCliffords --- -# CollectCliffords[¶](#collectcliffords "Permalink to this headline") +# CollectCliffords -`CollectCliffords(*args, **kwargs)` +`CollectCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_cliffords.py "view source code") Bases: [`qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse`](qiskit.transpiler.passes.CollectAndCollapse "qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectLinearFunctions.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectLinearFunctions.md index 2031d116dc2..dbf672a7d46 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectLinearFunctions.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectLinearFunctions.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.CollectLinearFunctions --- -# CollectLinearFunctions[¶](#collectlinearfunctions "Permalink to this headline") +# CollectLinearFunctions -`CollectLinearFunctions(*args, **kwargs)` +`CollectLinearFunctions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_linear_functions.py "view source code") Bases: [`qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse`](qiskit.transpiler.passes.CollectAndCollapse "qiskit.transpiler.passes.optimization.collect_and_collapse.CollectAndCollapse") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectMultiQBlocks.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectMultiQBlocks.md index ad70eaaf567..b00674be2b8 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectMultiQBlocks.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CollectMultiQBlocks.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.CollectMultiQBlocks --- -# CollectMultiQBlocks[¶](#collectmultiqblocks "Permalink to this headline") +# CollectMultiQBlocks -`CollectMultiQBlocks(*args, **kwargs)` +`CollectMultiQBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ A Disjont Set Union data structure (DSU) is used to maintain blocks as gates are -`CollectMultiQBlocks.find_set(index)` +`CollectMultiQBlocks.find_set(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for finding root of set of items If my parent is myself, I am the root. Otherwise we recursively find the root for my parent. After that, we assign my parent to be my root, saving recursion in the future. @@ -48,7 +48,7 @@ Return the name of the pass. -`CollectMultiQBlocks.run(dag)` +`CollectMultiQBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") Run the CollectMultiQBlocks pass on dag. @@ -62,7 +62,7 @@ After the execution, `property_set['block_list']` is set to a list of tuples of -`CollectMultiQBlocks.union_set(set1, set2)` +`CollectMultiQBlocks.union_set(set1, set2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/collect_multiqubit_blocks.py "view source code") DSU function for unioning two sets together Find the roots of each set. Then assign one to have the other as its parent, thus liking the sets. Merges smaller set into larger set in order to have better runtime diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutationAnalysis.md index dce3dd199e4..e82a960ed69 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutationAnalysis.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.CommutationAnalysis --- -# CommutationAnalysis[¶](#commutationanalysis "Permalink to this headline") +# CommutationAnalysis -`CommutationAnalysis(*args, **kwargs)` +`CommutationAnalysis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`CommutationAnalysis.run(dag)` +`CommutationAnalysis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutation_analysis.py "view source code") Run the CommutationAnalysis pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeCancellation.md index 5912f449d0e..687cceab07e 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeCancellation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.CommutativeCancellation --- -# CommutativeCancellation[¶](#commutativecancellation "Permalink to this headline") +# CommutativeCancellation -`CommutativeCancellation(*args, **kwargs)` +`CommutativeCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`CommutativeCancellation.run(dag)` +`CommutativeCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_cancellation.py "view source code") Run the CommutativeCancellation pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeInverseCancellation.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeInverseCancellation.md index 25eec0f63fa..b645f918dc1 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeInverseCancellation.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CommutativeInverseCancellation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.CommutativeInverseCancellation --- -# CommutativeInverseCancellation[¶](#commutativeinversecancellation "Permalink to this headline") +# CommutativeInverseCancellation -`CommutativeInverseCancellation(*args, **kwargs)` +`CommutativeInverseCancellation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`CommutativeInverseCancellation.run(dag)` +`CommutativeInverseCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/commutative_inverse_cancellation.py "view source code") Run the CommutativeInverseCancellation pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Commuting2qGateRouter.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Commuting2qGateRouter.md index e194d789956..9fcde788733 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Commuting2qGateRouter.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Commuting2qGateRouter.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.Commuting2qGateRouter --- -# Commuting2qGateRouter[¶](#commuting2qgaterouter "Permalink to this headline") +# Commuting2qGateRouter -`Commuting2qGateRouter(swap_strategy=None, edge_coloring=None)` +`Commuting2qGateRouter(swap_strategy=None, edge_coloring=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -92,7 +92,7 @@ Return the name of the pass. -`Commuting2qGateRouter.run(dag)` +`Commuting2qGateRouter.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Run the pass by decomposing the nodes it applies on. @@ -118,7 +118,7 @@ A dag where swaps have been added for the intended gate type. -`Commuting2qGateRouter.swap_decompose(dag, node, current_layout, swap_strategy)` +`Commuting2qGateRouter.swap_decompose(dag, node, current_layout, swap_strategy)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/commuting_2q_gate_routing/commuting_2q_gate_router.py "view source code") Take an instance of `Commuting2qBlock` and map it to the coupling map. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConsolidateBlocks.md index 677c53bd998..6f200010b02 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.ConsolidateBlocks --- -# ConsolidateBlocks[¶](#consolidateblocks "Permalink to this headline") +# ConsolidateBlocks -`ConsolidateBlocks(*args, **kwargs)` +`ConsolidateBlocks(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -45,7 +45,7 @@ Return the name of the pass. -`ConsolidateBlocks.run(dag)` +`ConsolidateBlocks.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/consolidate_blocks.py "view source code") Run the ConsolidateBlocks pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConstrainedReschedule.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConstrainedReschedule.md index 005dfdfacc5..e3338ffbebc 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConstrainedReschedule.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConstrainedReschedule.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.ConstrainedReschedule --- -# ConstrainedReschedule[¶](#constrainedreschedule "Permalink to this headline") +# ConstrainedReschedule -`ConstrainedReschedule(acquire_alignment=1, pulse_alignment=1)` +`ConstrainedReschedule(acquire_alignment=1, pulse_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -67,7 +67,7 @@ Return the name of the pass. -`ConstrainedReschedule.run(dag)` +`ConstrainedReschedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/reschedule.py "view source code") Run rescheduler. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ContainsInstruction.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ContainsInstruction.md index 768aef23866..bb0a6a7e261 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ContainsInstruction.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ContainsInstruction.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.ContainsInstruction --- -# ContainsInstruction[¶](#containsinstruction "Permalink to this headline") +# ContainsInstruction -`ContainsInstruction(instruction_name, recurse=True)` +`ContainsInstruction(instruction_name, recurse=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`ContainsInstruction.run(dag)` +`ContainsInstruction.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/contains_instruction.py "view source code") Run the ContainsInstruction pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConvertConditionsToIfOps.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConvertConditionsToIfOps.md index 0a1f28c4f67..2b0445928bc 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConvertConditionsToIfOps.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ConvertConditionsToIfOps.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.ConvertConditionsToIfOps --- -# ConvertConditionsToIfOps[¶](#convertconditionstoifops "Permalink to this headline") +# ConvertConditionsToIfOps -`ConvertConditionsToIfOps(*args, **kwargs)` +`ConvertConditionsToIfOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`ConvertConditionsToIfOps.run(dag)` +`ConvertConditionsToIfOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/convert_conditions_to_if_ops.py "view source code") Run a pass on the DAGCircuit. This is implemented by the pass developer. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOps.md index 7788589b0bb..24153ce7fd6 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOps.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.CountOps --- -# CountOps[¶](#countops "Permalink to this headline") +# CountOps -`CountOps(*args, **kwargs)` +`CountOps(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOps.run(dag)` +`CountOps.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops.py "view source code") Run the CountOps pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOpsLongestPath.md index 503aabb7555..82f8ffd2890 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.CountOpsLongestPath --- -# CountOpsLongestPath[¶](#countopslongestpath "Permalink to this headline") +# CountOpsLongestPath -`CountOpsLongestPath(*args, **kwargs)` +`CountOpsLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`CountOpsLongestPath.run(dag)` +`CountOpsLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/count_ops_longest_path.py "view source code") Run the CountOpsLongestPath pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index 2993f88069c..d12bbe32b93 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule --- -# CrosstalkAdaptiveSchedule[¶](#crosstalkadaptiveschedule "Permalink to this headline") +# CrosstalkAdaptiveSchedule -`CrosstalkAdaptiveSchedule(*args, **kwargs)` +`CrosstalkAdaptiveSchedule(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -50,7 +50,7 @@ CrosstalkAdaptiveSchedule initializer. -`CrosstalkAdaptiveSchedule.assign_gate_id(dag)` +`CrosstalkAdaptiveSchedule.assign_gate_id(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") ID for each gate @@ -58,7 +58,7 @@ ID for each gate -`CrosstalkAdaptiveSchedule.basic_bounds()` +`CrosstalkAdaptiveSchedule.basic_bounds()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Basic variable bounds for optimization @@ -66,7 +66,7 @@ Basic variable bounds for optimization -`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)` +`CrosstalkAdaptiveSchedule.check_dag_dependency(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") gate2 is a DAG dependent of gate1 if it is a descendant of gate1 @@ -74,7 +74,7 @@ gate2 is a DAG dependent of gate1 if it is a descendant of gate1 -`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)` +`CrosstalkAdaptiveSchedule.check_xtalk_dependency(t_1, t_2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Check if two gates have a crosstalk dependency. We do not consider crosstalk between pairs of single qubit gates. @@ -82,7 +82,7 @@ Check if two gates have a crosstalk dependency. We do not consider crosstalk bet -`CrosstalkAdaptiveSchedule.coherence_constraints()` +`CrosstalkAdaptiveSchedule.coherence_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set decoherence errors based on qubit lifetimes @@ -90,7 +90,7 @@ Set decoherence errors based on qubit lifetimes -`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)` +`CrosstalkAdaptiveSchedule.create_updated_dag(layers, barriers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given a set of layers and barriers, construct a new dag @@ -98,7 +98,7 @@ Given a set of layers and barriers, construct a new dag -`CrosstalkAdaptiveSchedule.create_z3_vars()` +`CrosstalkAdaptiveSchedule.create_z3_vars()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup the variables required for Z3 optimization @@ -106,7 +106,7 @@ Setup the variables required for Z3 optimization -`CrosstalkAdaptiveSchedule.cx_tuple(gate)` +`CrosstalkAdaptiveSchedule.cx_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for two-qubit gate Note: current implementation assumes that the CX error rates and crosstalk behavior are independent of gate direction @@ -114,7 +114,7 @@ Representation for two-qubit gate Note: current implementation assumes that the -`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)` +`CrosstalkAdaptiveSchedule.enforce_schedule_on_dag(input_gate_times)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Z3 outputs start times for each gate. Some gates need to be serialized to implement the Z3 schedule. This function inserts barriers to implement those serializations @@ -122,7 +122,7 @@ Z3 outputs start times for each gate. Some gates need to be serialized to implem -`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()` +`CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract the set of program gates which potentially have crosstalk noise @@ -130,7 +130,7 @@ Extract the set of program gates which potentially have crosstalk noise -`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)` +`CrosstalkAdaptiveSchedule.extract_dag_overlap_sets(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Currenty overlaps (A,B) are considered when A is a 2q gate and B is either 2q or 1q gate. @@ -138,7 +138,7 @@ Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. Cur -`CrosstalkAdaptiveSchedule.extract_solution()` +`CrosstalkAdaptiveSchedule.extract_solution()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Extract gate start and finish times from Z3 solution @@ -146,7 +146,7 @@ Extract gate start and finish times from Z3 solution -`CrosstalkAdaptiveSchedule.fidelity_constraints()` +`CrosstalkAdaptiveSchedule.fidelity_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Set gate fidelity based on gate overlap conditions @@ -154,7 +154,7 @@ Set gate fidelity based on gate overlap conditions -`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)` +`CrosstalkAdaptiveSchedule.filter_candidates(candidates, layer, layer_id, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG dependency with G, and if Z3 allows gates in L and G to overlap. @@ -162,7 +162,7 @@ For a gate G and layer L, L is a candidate layer for G if no gate in L has a DAG -`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)` +`CrosstalkAdaptiveSchedule.find_layer(layers, triplet)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Find the appropriate layer for a gate @@ -170,7 +170,7 @@ Find the appropriate layer for a gate -`CrosstalkAdaptiveSchedule.gate_tuple(gate)` +`CrosstalkAdaptiveSchedule.gate_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for gate @@ -178,7 +178,7 @@ Representation for gate -`CrosstalkAdaptiveSchedule.generate_barriers(layers)` +`CrosstalkAdaptiveSchedule.generate_barriers(layers)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") For each gate g, see if a barrier is required to serialize it with some previously processed gate @@ -186,7 +186,7 @@ For each gate g, see if a barrier is required to serialize it with some previous -`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)` +`CrosstalkAdaptiveSchedule.is_significant_xtalk(gate1, gate2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Given two conditional gate error rates check if there is high crosstalk by comparing with independent error rates. @@ -202,7 +202,7 @@ Return the name of the pass. -`CrosstalkAdaptiveSchedule.objective_function()` +`CrosstalkAdaptiveSchedule.objective_function()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Objective function is a weighted combination of gate errors and decoherence errors @@ -210,7 +210,7 @@ Objective function is a weighted combination of gate errors and decoherence erro -`CrosstalkAdaptiveSchedule.parse_backend_properties()` +`CrosstalkAdaptiveSchedule.parse_backend_properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") This function assumes that gate durations and coherence times are in seconds in backend.properties() This function converts gate durations and coherence times to nanoseconds. @@ -218,7 +218,7 @@ This function assumes that gate durations and coherence times are in seconds in -`CrosstalkAdaptiveSchedule.powerset(iterable)` +`CrosstalkAdaptiveSchedule.powerset(iterable)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Finds the set of all subsets of the given iterable This function is used to generate constraints for the Z3 optimization @@ -226,7 +226,7 @@ Finds the set of all subsets of the given iterable This function is used to gene -`CrosstalkAdaptiveSchedule.r2f(val)` +`CrosstalkAdaptiveSchedule.r2f(val)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Convert Z3 Real to Python float @@ -234,7 +234,7 @@ Convert Z3 Real to Python float -`CrosstalkAdaptiveSchedule.reset()` +`CrosstalkAdaptiveSchedule.reset()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Reset variables @@ -242,7 +242,7 @@ Reset variables -`CrosstalkAdaptiveSchedule.run(dag)` +`CrosstalkAdaptiveSchedule.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Main scheduling function @@ -250,7 +250,7 @@ Main scheduling function -`CrosstalkAdaptiveSchedule.scheduling_constraints()` +`CrosstalkAdaptiveSchedule.scheduling_constraints()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") DAG scheduling constraints optimization Sets overlap indicator variables @@ -258,7 +258,7 @@ DAG scheduling constraints optimization Sets overlap indicator variables -`CrosstalkAdaptiveSchedule.singleq_tuple(gate)` +`CrosstalkAdaptiveSchedule.singleq_tuple(gate)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Representation for single-qubit gate @@ -266,7 +266,7 @@ Representation for single-qubit gate -`CrosstalkAdaptiveSchedule.solve_optimization()` +`CrosstalkAdaptiveSchedule.solve_optimization()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/crosstalk_adaptive_schedule.py "view source code") Setup and solve a Z3 optimization for finding the best schedule diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGFixedPoint.md index 7093921b1a6..ada5bb2b01f 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGFixedPoint.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.DAGFixedPoint --- -# DAGFixedPoint[¶](#dagfixedpoint "Permalink to this headline") +# DAGFixedPoint -`DAGFixedPoint(*args, **kwargs)` +`DAGFixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`DAGFixedPoint.run(dag)` +`DAGFixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/dag_fixed_point.py "view source code") Run the DAGFixedPoint pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGLongestPath.md index 7599f1ec791..6c031c6c758 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DAGLongestPath.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.DAGLongestPath --- -# DAGLongestPath[¶](#daglongestpath "Permalink to this headline") +# DAGLongestPath -`DAGLongestPath(*args, **kwargs)` +`DAGLongestPath(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`DAGLongestPath.run(dag)` +`DAGLongestPath.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/dag_longest_path.py "view source code") Run the DAGLongestPath pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Decompose.md index 4c838efbaaa..71a9e9e3d33 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Decompose.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.Decompose --- -# Decompose[¶](#decompose "Permalink to this headline") +# Decompose -`Decompose(gates_to_decompose=None)` +`Decompose(gates_to_decompose=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/decompose.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`Decompose.run(dag)` +`Decompose.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/decompose.py "view source code") Run the Decompose pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DenseLayout.md index 1eb70a49e7a..67cb56d7a6b 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DenseLayout.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.DenseLayout --- -# DenseLayout[¶](#denselayout "Permalink to this headline") +# DenseLayout -`DenseLayout(*args, **kwargs)` +`DenseLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -44,7 +44,7 @@ Return the name of the pass. -`DenseLayout.run(dag)` +`DenseLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/dense_layout.py "view source code") Run the DenseLayout pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Depth.md index 8bf44ac6f0d..4090dc1b76f 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Depth.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.Depth --- -# Depth[¶](#depth "Permalink to this headline") +# Depth -`Depth(*args, **kwargs)` +`Depth(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/depth.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`Depth.run(dag)` +`Depth.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/depth.py "view source code") Run the Depth pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DynamicalDecoupling.md index dda61b29273..4575c22b175 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.DynamicalDecoupling --- -# DynamicalDecoupling[¶](#dynamicaldecoupling "Permalink to this headline") +# DynamicalDecoupling -`DynamicalDecoupling(*args, **kwargs)` +`DynamicalDecoupling(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -98,7 +98,7 @@ Return the name of the pass. -`DynamicalDecoupling.run(dag)` +`DynamicalDecoupling.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/dynamical_decoupling.py "view source code") Run the DynamicalDecoupling pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md index 73a4d5c8e8a..3b38a4c450f 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.EchoRZXWeylDecomposition.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.EchoRZXWeylDecomposition --- -# EchoRZXWeylDecomposition[¶](#echorzxweyldecomposition "Permalink to this headline") +# EchoRZXWeylDecomposition -`EchoRZXWeylDecomposition(*args, **kwargs)` +`EchoRZXWeylDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`EchoRZXWeylDecomposition.run(dag)` +`EchoRZXWeylDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/echo_rzx_weyl_decomposition.py "view source code") Run the EchoRZXWeylDecomposition pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.EnlargeWithAncilla.md index 21ee17caa50..b957cc8f92a 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla --- -# EnlargeWithAncilla[¶](#enlargewithancilla "Permalink to this headline") +# EnlargeWithAncilla -`EnlargeWithAncilla(*args, **kwargs)` +`EnlargeWithAncilla(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`EnlargeWithAncilla.run(dag)` +`EnlargeWithAncilla.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/enlarge_with_ancilla.py "view source code") Run the EnlargeWithAncilla pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.FixedPoint.md index dd4cc4328b4..40f2ff0ebc2 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.FixedPoint.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.FixedPoint --- -# FixedPoint[¶](#fixedpoint "Permalink to this headline") +# FixedPoint -`FixedPoint(*args, **kwargs)` +`FixedPoint(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`FixedPoint.run(dag)` +`FixedPoint.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/fixed_point.py "view source code") Run the FixedPoint pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.FullAncillaAllocation.md index 565a5b31f0c..2189ad9f1a5 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.FullAncillaAllocation --- -# FullAncillaAllocation[¶](#fullancillaallocation "Permalink to this headline") +# FullAncillaAllocation -`FullAncillaAllocation(*args, **kwargs)` +`FullAncillaAllocation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -42,7 +42,7 @@ Return the name of the pass. -`FullAncillaAllocation.run(dag)` +`FullAncillaAllocation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Run the FullAncillaAllocation pass on dag. @@ -70,7 +70,7 @@ returns the same dag circuit, unmodified -`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)` +`static FullAncillaAllocation.validate_layout(layout_qubits, dag_qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/full_ancilla_allocation.py "view source code") Checks if all the qregs in layout\_qregs already exist in dag\_qregs. Otherwise, raise. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.GateDirection.md index 3269703fc33..196c151ac92 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.GateDirection.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.GateDirection --- -# GateDirection[¶](#gatedirection "Permalink to this headline") +# GateDirection -`GateDirection(*args, **kwargs)` +`GateDirection(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -59,7 +59,7 @@ Return the name of the pass. -`GateDirection.run(dag)` +`GateDirection.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gate_direction.py "view source code") Run the GateDirection pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.GatesInBasis.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.GatesInBasis.md index ef5f96bf6a4..9320420c64f 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.GatesInBasis.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.GatesInBasis.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.GatesInBasis --- -# GatesInBasis[¶](#gatesinbasis "Permalink to this headline") +# GatesInBasis -`GatesInBasis(*args, **kwargs)` +`GatesInBasis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`GatesInBasis.run(dag)` +`GatesInBasis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/gates_basis.py "view source code") Run the GatesInBasis pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.HighLevelSynthesis.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.HighLevelSynthesis.md index 9947e002511..c47de4326d1 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.HighLevelSynthesis.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.HighLevelSynthesis.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.HighLevelSynthesis --- -# HighLevelSynthesis[¶](#highlevelsynthesis "Permalink to this headline") +# HighLevelSynthesis -`HighLevelSynthesis(*args, **kwargs)` +`HighLevelSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -40,7 +40,7 @@ Return the name of the pass. -`HighLevelSynthesis.run(dag)` +`HighLevelSynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Run the HighLevelSynthesis pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: input dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.HoareOptimizer.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.HoareOptimizer.md index ff40a54a310..305486d0d0f 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.HoareOptimizer.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.HoareOptimizer.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.HoareOptimizer --- -# HoareOptimizer[¶](#hoareoptimizer "Permalink to this headline") +# HoareOptimizer -`HoareOptimizer(*args, **kwargs)` +`HoareOptimizer(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`HoareOptimizer.run(dag)` +`HoareOptimizer.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/hoare_opt.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.InstructionDurationCheck.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.InstructionDurationCheck.md index 992bf8a7c8b..0d79135232d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.InstructionDurationCheck.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.InstructionDurationCheck.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.InstructionDurationCheck --- -# InstructionDurationCheck[¶](#instructiondurationcheck "Permalink to this headline") +# InstructionDurationCheck -`InstructionDurationCheck(acquire_alignment=1, pulse_alignment=1)` +`InstructionDurationCheck(acquire_alignment=1, pulse_alignment=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -43,7 +43,7 @@ Return the name of the pass. -`InstructionDurationCheck.run(dag)` +`InstructionDurationCheck.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/check_durations.py "view source code") Run duration validation passes. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.InverseCancellation.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.InverseCancellation.md index 42296b0e92e..542209b6847 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.InverseCancellation.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.InverseCancellation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.InverseCancellation --- -# InverseCancellation[¶](#inversecancellation "Permalink to this headline") +# InverseCancellation -`InverseCancellation(gates_to_cancel)` +`InverseCancellation(gates_to_cancel)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -40,7 +40,7 @@ Return the name of the pass. -`InverseCancellation.run(dag)` +`InverseCancellation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/inverse_cancellation.py "view source code") Run the InverseCancellation pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.KMSSynthesisPermutation.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.KMSSynthesisPermutation.md index 914c856fcc5..f0a0084a78d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.KMSSynthesisPermutation.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.KMSSynthesisPermutation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.KMSSynthesisPermutation --- -# KMSSynthesisPermutation[¶](#kmssynthesispermutation "Permalink to this headline") +# KMSSynthesisPermutation -`KMSSynthesisPermutation` +`KMSSynthesisPermutation`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") @@ -43,7 +43,7 @@ print(f"kms: {qct.size() = }, {qct.depth() = }") -`KMSSynthesisPermutation.run(high_level_object, **options)` +`KMSSynthesisPermutation.run(high_level_object, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/high_level_synthesis.py "view source code") Run synthesis for the given Permutation. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Layout2qDistance.md index 4fd69a39b7d..ca74ca67b4e 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Layout2qDistance.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.Layout2qDistance --- -# Layout2qDistance[¶](#layout2qdistance "Permalink to this headline") +# Layout2qDistance -`Layout2qDistance(*args, **kwargs)` +`Layout2qDistance(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -39,7 +39,7 @@ Return the name of the pass. -`Layout2qDistance.run(dag)` +`Layout2qDistance.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/layout_2q_distance.py "view source code") Run the Layout2qDistance pass on dag. :param dag: DAG to evaluate. :type dag: DAGCircuit diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsSynthesis.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsSynthesis.md index dd1d2a18a26..e58d7e51aa9 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsSynthesis.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsSynthesis.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.LinearFunctionsSynthesis --- -# LinearFunctionsSynthesis[¶](#linearfunctionssynthesis "Permalink to this headline") +# LinearFunctionsSynthesis -`LinearFunctionsSynthesis(*args, **kwargs)` +`LinearFunctionsSynthesis(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsToPermutations.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsToPermutations.md index 1619dfbb142..0e941d8d9e6 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsToPermutations.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.LinearFunctionsToPermutations.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.LinearFunctionsToPermutations --- -# LinearFunctionsToPermutations[¶](#linearfunctionstopermutations "Permalink to this headline") +# LinearFunctionsToPermutations -`LinearFunctionsToPermutations(*args, **kwargs)` +`LinearFunctionsToPermutations(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`LinearFunctionsToPermutations.run(dag)` +`LinearFunctionsToPermutations.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/linear_functions_synthesis.py "view source code") Run the LinearFunctionsToPermutations pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: input dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.LookaheadSwap.md index 6f522846504..1864eea3199 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.LookaheadSwap.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.LookaheadSwap --- -# LookaheadSwap[¶](#lookaheadswap "Permalink to this headline") +# LookaheadSwap -`LookaheadSwap(*args, **kwargs)` +`LookaheadSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -55,7 +55,7 @@ Return the name of the pass. -`LookaheadSwap.run(dag)` +`LookaheadSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/lookahead_swap.py "view source code") Run the LookaheadSwap pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.MergeAdjacentBarriers.md index ac5767fecd5..65666f25189 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers --- -# MergeAdjacentBarriers[¶](#mergeadjacentbarriers "Permalink to this headline") +# MergeAdjacentBarriers -`MergeAdjacentBarriers(*args, **kwargs)` +`MergeAdjacentBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -67,7 +67,7 @@ Return the name of the pass. -`MergeAdjacentBarriers.run(dag)` +`MergeAdjacentBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/merge_adjacent_barriers.py "view source code") Run the MergeAdjacentBarriers pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index 5b9862659e2..de45437444d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout --- -# NoiseAdaptiveLayout[¶](#noiseadaptivelayout "Permalink to this headline") +# NoiseAdaptiveLayout -`NoiseAdaptiveLayout(*args, **kwargs)` +`NoiseAdaptiveLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -20,12 +20,8 @@ Choose a noise-adaptive Layout based on current calibration data for the backend > > The pass implements the qubit mapping method from: Noise-Adaptive Compiler Mappings for Noisy Intermediate-Scale Quantum Computers Prakash Murali, Jonathan M. Baker, Ali Javadi-Abhari, Frederic T. Chong, Margaret R. Martonosi ASPLOS 2019 (arXiv:1901.11054). - - `Ordering of edges` - - `Map qubits edge-by-edge in the order of decreasing frequency of occurrence in the program dag.` ### Initialization @@ -34,40 +30,22 @@ Choose a noise-adaptive Layout based on current calibration data for the backend `Initialization()` - - `If an edge exists with both endpoints unmapped,` - - `pick the best available hardware cx to execute this edge.` - - `Iterative step` - - `When an edge exists with one endpoint unmapped,` - - `map that endpoint to a location which allows` - - `maximum reliability for CNOTs with previously mapped qubits.` - - `In the end if there are unmapped qubits (which don't` - - `participate in any CNOT), map them to any available` - - `hardware qubit.` ### Notes @@ -102,7 +80,7 @@ Return the name of the pass. -`NoiseAdaptiveLayout.run(dag)` +`NoiseAdaptiveLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/noise_adaptive_layout.py "view source code") Run the NoiseAdaptiveLayout pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.NumTensorFactors.md index 420218bf697..ca00260f50d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.NumTensorFactors.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.NumTensorFactors --- -# NumTensorFactors[¶](#numtensorfactors "Permalink to this headline") +# NumTensorFactors -`NumTensorFactors(*args, **kwargs)` +`NumTensorFactors(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`NumTensorFactors.run(dag)` +`NumTensorFactors.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/num_tensor_factors.py "view source code") Run the NumTensorFactors pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGates.md index 88b00581de3..f06ef2692a9 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGates.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.Optimize1qGates --- -# Optimize1qGates[¶](#optimize1qgates "Permalink to this headline") +# Optimize1qGates -`Optimize1qGates(*args, **kwargs)` +`Optimize1qGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -29,7 +29,7 @@ Optimize1qGates initializer. -`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)` +`static Optimize1qGates.compose_u3(theta1, phi1, lambda1, theta2, phi2, lambda2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Return a triple theta, phi, lambda for the product. @@ -51,7 +51,7 @@ Return the name of the pass. -`Optimize1qGates.run(dag)` +`Optimize1qGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Run the Optimize1qGates pass on dag. @@ -75,7 +75,7 @@ the optimized DAG. -`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)` +`static Optimize1qGates.yzy_to_zyz(xi, theta1, theta2, eps=1e-09)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_gates.py "view source code") Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index daf32b3e90b..323bb4c6971 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition --- -# Optimize1qGatesDecomposition[¶](#optimize1qgatesdecomposition "Permalink to this headline") +# Optimize1qGatesDecomposition -`Optimize1qGatesDecomposition(*args, **kwargs)` +`Optimize1qGatesDecomposition(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -46,7 +46,7 @@ Return the name of the pass. -`Optimize1qGatesDecomposition.run(dag)` +`Optimize1qGatesDecomposition.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_decomposition.py "view source code") Run the Optimize1qGatesDecomposition pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md index 9bd2516a14e..cdb89beeeb9 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.Optimize1qGatesSimpleCommutation --- -# Optimize1qGatesSimpleCommutation[¶](#optimize1qgatessimplecommutation "Permalink to this headline") +# Optimize1qGatesSimpleCommutation -`Optimize1qGatesSimpleCommutation(*args, **kwargs)` +`Optimize1qGatesSimpleCommutation(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`Optimize1qGatesSimpleCommutation.run(dag)` +`Optimize1qGatesSimpleCommutation.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_1q_commutation.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.OptimizeCliffords.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.OptimizeCliffords.md index 2113ffc3fc2..550684b2578 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.OptimizeCliffords.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.OptimizeCliffords.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.OptimizeCliffords --- -# OptimizeCliffords[¶](#optimizecliffords "Permalink to this headline") +# OptimizeCliffords -`OptimizeCliffords(*args, **kwargs)` +`OptimizeCliffords(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`OptimizeCliffords.run(dag)` +`OptimizeCliffords.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/optimize_cliffords.py "view source code") Run the OptimizeCliffords pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDelay.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDelay.md index 0de15d9f741..1a5fbf4d4f4 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDelay.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDelay.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.PadDelay --- -# PadDelay[¶](#paddelay "Permalink to this headline") +# PadDelay -`PadDelay(fill_very_end=True)` +`PadDelay(fill_very_end=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/padding/pad_delay.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDynamicalDecoupling.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDynamicalDecoupling.md index 9dd8368e2fd..85101020dd0 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDynamicalDecoupling.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.PadDynamicalDecoupling.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.PadDynamicalDecoupling --- -# PadDynamicalDecoupling[¶](#paddynamicaldecoupling "Permalink to this headline") +# PadDynamicalDecoupling -`PadDynamicalDecoupling(durations, dd_sequence, qubits=None, spacing=None, skip_reset_qubits=True, pulse_alignment=1, extra_slack_distribution='middle')` +`PadDynamicalDecoupling(durations, dd_sequence, qubits=None, spacing=None, skip_reset_qubits=True, pulse_alignment=1, extra_slack_distribution='middle')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/padding/dynamical_decoupling.py "view source code") Bases: `qiskit.transpiler.passes.scheduling.padding.base_padding.BasePadding` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.PulseGates.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.PulseGates.md index 6c012b057fd..52516d51c0d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.PulseGates.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.PulseGates.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.PulseGates --- -# PulseGates[¶](#pulsegates "Permalink to this headline") +# PulseGates -`PulseGates(inst_map)` +`PulseGates(inst_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Bases: `qiskit.transpiler.passes.calibration.base_builder.CalibrationBuilder` @@ -40,7 +40,7 @@ Create new pass. -`PulseGates.get_calibration(node_op, qubits)` +`PulseGates.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Gets the calibrated schedule for the given instruction and qubits. @@ -89,7 +89,7 @@ A DAG with calibrations added to it. -`PulseGates.supported(node_op, qubits)` +`PulseGates.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/pulse_gate.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilder.md index e75f82096b1..028009112cc 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder --- -# RZXCalibrationBuilder[¶](#rzxcalibrationbuilder "Permalink to this headline") +# RZXCalibrationBuilder -`RZXCalibrationBuilder(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)` +`RZXCalibrationBuilder(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: `qiskit.transpiler.passes.calibration.base_builder.CalibrationBuilder` @@ -34,7 +34,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilder.get_calibration(node_op, qubits)` +`RZXCalibrationBuilder.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Builds the calibration schedule for the RZXGate(theta) with echos. @@ -69,7 +69,7 @@ Return the name of the pass. -`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)` +`static RZXCalibrationBuilder.rescale_cr_inst(instruction, theta, sample_mult=16)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") A builder macro to play stretched pulse. @@ -115,7 +115,7 @@ A DAG with calibrations added to it. -`RZXCalibrationBuilder.supported(node_op, qubits)` +`RZXCalibrationBuilder.supported(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Determine if a given node supports the calibration. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index 60451bf98b7..dc933889fd9 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho --- -# RZXCalibrationBuilderNoEcho[¶](#rzxcalibrationbuildernoecho "Permalink to this headline") +# RZXCalibrationBuilderNoEcho -`RZXCalibrationBuilderNoEcho(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)` +`RZXCalibrationBuilderNoEcho(instruction_schedule_map=None, qubit_channel_mapping=None, verbose=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Bases: [`qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.calibration.rzx_builder.RZXCalibrationBuilder") @@ -36,7 +36,7 @@ Initializes a RZXGate calibration builder. -`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)` +`RZXCalibrationBuilderNoEcho.get_calibration(node_op, qubits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/calibration/rzx_builder.py "view source code") Builds the calibration schedule for the RZXGate(theta) without echos. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveBarriers.md index b493905f0a8..60ad694aa6e 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveBarriers.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.RemoveBarriers --- -# RemoveBarriers[¶](#removebarriers "Permalink to this headline") +# RemoveBarriers -`RemoveBarriers(*args, **kwargs)` +`RemoveBarriers(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -49,7 +49,7 @@ Return the name of the pass. -`RemoveBarriers.run(dag)` +`RemoveBarriers.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_barriers.py "view source code") Run the RemoveBarriers pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index c9858e98cb4..f7be66080e1 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure --- -# RemoveDiagonalGatesBeforeMeasure[¶](#removediagonalgatesbeforemeasure "Permalink to this headline") +# RemoveDiagonalGatesBeforeMeasure -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` +`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`RemoveDiagonalGatesBeforeMeasure.run(dag)` +`RemoveDiagonalGatesBeforeMeasure.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_diagonal_gates_before_measure.py "view source code") Run the RemoveDiagonalGatesBeforeMeasure pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveFinalMeasurements.md index 1b9c8486fa0..ee3a43885ec 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements --- -# RemoveFinalMeasurements[¶](#removefinalmeasurements "Permalink to this headline") +# RemoveFinalMeasurements -`RemoveFinalMeasurements(*args, **kwargs)` +`RemoveFinalMeasurements(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -34,7 +34,7 @@ Return the name of the pass. -`RemoveFinalMeasurements.run(dag)` +`RemoveFinalMeasurements.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/utils/remove_final_measurements.py "view source code") Run the RemoveFinalMeasurements pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveResetInZeroState.md index 0f2d778d9b1..44d7f6dd71b 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState --- -# RemoveResetInZeroState[¶](#removeresetinzerostate "Permalink to this headline") +# RemoveResetInZeroState -`RemoveResetInZeroState(*args, **kwargs)` +`RemoveResetInZeroState(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -30,7 +30,7 @@ Return the name of the pass. -`RemoveResetInZeroState.run(dag)` +`RemoveResetInZeroState.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/remove_reset_in_zero_state.py "view source code") Run the RemoveResetInZeroState pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md index ad7462b9235..860f3b34919 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ResetAfterMeasureSimplification.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.ResetAfterMeasureSimplification --- -# ResetAfterMeasureSimplification[¶](#resetaftermeasuresimplification "Permalink to this headline") +# ResetAfterMeasureSimplification -`ResetAfterMeasureSimplification(*args, **kwargs)` +`ResetAfterMeasureSimplification(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`ResetAfterMeasureSimplification.run(dag)` +`ResetAfterMeasureSimplification.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/reset_after_measure_simplification.py "view source code") Run the pass on a dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreLayout.md index 0fff774e044..eb3e36b5d62 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreLayout.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.SabreLayout --- -# SabreLayout[¶](#sabrelayout "Permalink to this headline") +# SabreLayout -`SabreLayout(*args, **kwargs)` +`SabreLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -59,7 +59,7 @@ Return the name of the pass. -`SabreLayout.run(dag)` +`SabreLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/sabre_layout.py "view source code") Run the SabreLayout pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreSwap.md index 142463faec3..8274d0b0798 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SabreSwap.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.SabreSwap --- -# SabreSwap[¶](#sabreswap "Permalink to this headline") +# SabreSwap -`SabreSwap(*args, **kwargs)` +`SabreSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -90,7 +90,7 @@ Return the name of the pass. -`SabreSwap.run(dag)` +`SabreSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/sabre_swap.py "view source code") Run the SabreSwap pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetIOLatency.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetIOLatency.md index 348fbe8e49f..465dcc939e1 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetIOLatency.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetIOLatency.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.SetIOLatency --- -# SetIOLatency[¶](#setiolatency "Permalink to this headline") +# SetIOLatency -`SetIOLatency(clbit_write_latency=0, conditional_latency=0)` +`SetIOLatency(clbit_write_latency=0, conditional_latency=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -41,7 +41,7 @@ Return the name of the pass. -`SetIOLatency.run(dag)` +`SetIOLatency.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/scheduling/set_io_latency.py "view source code") Add IO latency information. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetLayout.md index a7fce7ab9d1..af55e1faf61 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SetLayout.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.SetLayout --- -# SetLayout[¶](#setlayout "Permalink to this headline") +# SetLayout -`SetLayout(*args, **kwargs)` +`SetLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/set_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`SetLayout.run(dag)` +`SetLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/set_layout.py "view source code") Run the SetLayout pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Size.md index da34e40f3ba..c07b8b5bc77 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Size.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.Size --- -# Size[¶](#size "Permalink to this headline") +# Size -`Size(*args, **kwargs)` +`Size(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/size.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -36,7 +36,7 @@ Return the name of the pass. -`Size.run(dag)` +`Size.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/size.py "view source code") Run the Size pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaev.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaev.md index fbcc1700bdd..8463528e429 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaev.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaev.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.SolovayKitaev --- -# SolovayKitaev[¶](#solovaykitaev "Permalink to this headline") +# SolovayKitaev -`SolovayKitaev(*args, **kwargs)` +`SolovayKitaev(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -119,7 +119,7 @@ Return the name of the pass. -`SolovayKitaev.run(dag)` +`SolovayKitaev.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Run the `SolovayKitaev` pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaevSynthesis.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaevSynthesis.md index f22128b7131..da3fdb354f1 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaevSynthesis.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.SolovayKitaevSynthesis.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.SolovayKitaevSynthesis --- -# SolovayKitaevSynthesis[¶](#solovaykitaevsynthesis "Permalink to this headline") +# SolovayKitaevSynthesis -`SolovayKitaevSynthesis` +`SolovayKitaevSynthesis`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") @@ -44,7 +44,7 @@ The number of times the decomposition is recursively improved. If None, defaults -`SolovayKitaevSynthesis.run(unitary, **options)` +`SolovayKitaevSynthesis.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/solovay_kitaev_synthesis.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.StochasticSwap.md index b843d824b62..2651c8b465d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.StochasticSwap.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.StochasticSwap --- -# StochasticSwap[¶](#stochasticswap "Permalink to this headline") +# StochasticSwap -`StochasticSwap(*args, **kwargs)` +`StochasticSwap(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -51,7 +51,7 @@ Return the name of the pass. -`StochasticSwap.run(dag)` +`StochasticSwap.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/routing/stochastic_swap.py "view source code") Run the StochasticSwap pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TemplateOptimization.md index a8414c2f420..185337b2581 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TemplateOptimization.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.TemplateOptimization --- -# TemplateOptimization[¶](#templateoptimization "Permalink to this headline") +# TemplateOptimization -`TemplateOptimization(*args, **kwargs)` +`TemplateOptimization(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`TemplateOptimization.run(dag)` +`TemplateOptimization.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") **Parameters** diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TimeUnitConversion.md index c613e8f27d1..c4dfe0bbd72 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TimeUnitConversion.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.TimeUnitConversion --- -# TimeUnitConversion[¶](#timeunitconversion "Permalink to this headline") +# TimeUnitConversion -`TimeUnitConversion(inst_durations)` +`TimeUnitConversion(inst_durations)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -44,7 +44,7 @@ Return the name of the pass. -`TimeUnitConversion.run(dag)` +`TimeUnitConversion.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/time_unit_conversion.py "view source code") Run the TimeUnitAnalysis pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TranslateParameterizedGates.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TranslateParameterizedGates.md index 21963d5e436..e6395c1a1e7 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TranslateParameterizedGates.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TranslateParameterizedGates.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.TranslateParameterizedGates --- -# TranslateParameterizedGates[¶](#translateparameterizedgates "Permalink to this headline") +# TranslateParameterizedGates -`TranslateParameterizedGates(*args, **kwargs)` +`TranslateParameterizedGates(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -87,7 +87,7 @@ Return the name of the pass. -`TranslateParameterizedGates.run(dag)` +`TranslateParameterizedGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/translate_parameterized.py "view source code") Run the transpiler pass. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TrivialLayout.md index f378cb0d4f9..f1af0f14b1c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.TrivialLayout.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.TrivialLayout --- -# TrivialLayout[¶](#triviallayout "Permalink to this headline") +# TrivialLayout -`TrivialLayout(*args, **kwargs)` +`TrivialLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -46,7 +46,7 @@ Return the name of the pass. -`TrivialLayout.run(dag)` +`TrivialLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/trivial_layout.py "view source code") Run the TrivialLayout pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnitarySynthesis.md index 9233098f62e..3eaffbdc737 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnitarySynthesis.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.UnitarySynthesis --- -# UnitarySynthesis[¶](#unitarysynthesis "Permalink to this headline") +# UnitarySynthesis -`UnitarySynthesis(basis_gates=None, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None, target=None)` +`UnitarySynthesis(basis_gates=None, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None, method='default', min_qubits=None, plugin_config=None, target=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -48,7 +48,7 @@ Return the name of the pass. -`UnitarySynthesis.run(dag)` +`UnitarySynthesis.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/unitary_synthesis.py "view source code") Run the UnitarySynthesis pass on `dag`. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroll3qOrMore.md index f708d66b246..c87f7fb0563 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.Unroll3qOrMore --- -# Unroll3qOrMore[¶](#unroll3qormore "Permalink to this headline") +# Unroll3qOrMore -`Unroll3qOrMore(*args, **kwargs)` +`Unroll3qOrMore(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -37,7 +37,7 @@ Return the name of the pass. -`Unroll3qOrMore.run(dag)` +`Unroll3qOrMore.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_3q_or_more.py "view source code") Run the Unroll3qOrMore pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnrollCustomDefinitions.md index 0d6beb881b3..fa05395e7ae 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions --- -# UnrollCustomDefinitions[¶](#unrollcustomdefinitions "Permalink to this headline") +# UnrollCustomDefinitions -`UnrollCustomDefinitions(*args, **kwargs)` +`UnrollCustomDefinitions(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`UnrollCustomDefinitions.run(dag)` +`UnrollCustomDefinitions.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroll_custom_definitions.py "view source code") Run the UnrollCustomDefinitions pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroller.md index 0be5921344b..84c61bf79af 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Unroller.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.Unroller --- -# Unroller[¶](#unroller "Permalink to this headline") +# Unroller -`Unroller(*args, **kwargs)` +`Unroller(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroller.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -38,7 +38,7 @@ Return the name of the pass. -`Unroller.run(dag)` +`Unroller.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/basis/unroller.py "view source code") Run the Unroller pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2Layout.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2Layout.md index 4136c279522..3092315c2b5 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2Layout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2Layout.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.VF2Layout --- -# VF2Layout[¶](#vf2layout "Permalink to this headline") +# VF2Layout -`VF2Layout(*args, **kwargs)` +`VF2Layout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -66,7 +66,7 @@ Return the name of the pass. -`VF2Layout.run(dag)` +`VF2Layout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2PostLayout.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2PostLayout.md index 85908e859d9..a75552dfac1 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2PostLayout.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.VF2PostLayout.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.VF2PostLayout --- -# VF2PostLayout[¶](#vf2postlayout "Permalink to this headline") +# VF2PostLayout -`VF2PostLayout(*args, **kwargs)` +`VF2PostLayout(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -67,7 +67,7 @@ Return the name of the pass. -`VF2PostLayout.run(dag)` +`VF2PostLayout.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/layout/vf2_post_layout.py "view source code") run the layout method diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ValidatePulseGates.md index 1bbbb5b7a56..d190bc870bf 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.ValidatePulseGates.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.ValidatePulseGates --- -# ValidatePulseGates[¶](#validatepulsegates "Permalink to this headline") +# ValidatePulseGates -`ValidatePulseGates(granularity=1, min_length=1)` +`ValidatePulseGates(granularity=1, min_length=1)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -45,7 +45,7 @@ Return the name of the pass. -`ValidatePulseGates.run(dag)` +`ValidatePulseGates.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/scheduling/alignments/pulse_gate_validation.py "view source code") Run the pulse gate validation attached to `dag`. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Width.md index 891b75c7be7..19873d0bd78 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.Width.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.Width --- -# Width[¶](#width "Permalink to this headline") +# Width -`Width(*args, **kwargs)` +`Width(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/width.py "view source code") Bases: [`qiskit.transpiler.basepasses.AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.basepasses.AnalysisPass") @@ -32,7 +32,7 @@ Return the name of the pass. -`Width.run(dag)` +`Width.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/analysis/width.py "view source code") Run the Width pass on dag. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md index 8472651b21d..9a52ea85f26 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin --- -# HighLevelSynthesisPlugin[¶](#highlevelsynthesisplugin "Permalink to this headline") +# HighLevelSynthesisPlugin -`HighLevelSynthesisPlugin` +`HighLevelSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This abstract class defines the interface for high-level synthesis plugins. -`abstract HighLevelSynthesisPlugin.run(high_level_object, **options)` +`abstract HighLevelSynthesisPlugin.run(high_level_object, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Run synthesis for the given Operation. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md index d6b1c75715b..af10d36ed2c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPluginManager --- -# HighLevelSynthesisPluginManager[¶](#highlevelsynthesispluginmanager "Permalink to this headline") +# HighLevelSynthesisPluginManager -`HighLevelSynthesisPluginManager` +`HighLevelSynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Class tracking the installed high-level-synthesis plugins. -`HighLevelSynthesisPluginManager.method(op_name, method_name)` +`HighLevelSynthesisPluginManager.method(op_name, method_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Returns the plugin for `op_name` and `method_name`. @@ -30,7 +30,7 @@ Returns the plugin for `op_name` and `method_name`. -`HighLevelSynthesisPluginManager.method_names(op_name)` +`HighLevelSynthesisPluginManager.method_names(op_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Returns plugin methods for op\_name. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md index f8c550a6d1d..2cf4289ae62 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin --- -# UnitarySynthesisPlugin[¶](#unitarysynthesisplugin "Permalink to this headline") +# UnitarySynthesisPlugin -`UnitarySynthesisPlugin` +`UnitarySynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ This abstract class defines the interface for unitary synthesis plugins. -`abstract UnitarySynthesisPlugin.run(unitary, **options)` +`abstract UnitarySynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md index ed4d07679e2..15399e0b525 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager --- -# UnitarySynthesisPluginManager[¶](#unitarysynthesispluginmanager "Permalink to this headline") +# UnitarySynthesisPluginManager -`UnitarySynthesisPluginManager` +`UnitarySynthesisPluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md index 0806e75a926..462219d3000 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names --- -# qiskit.transpiler.passes.synthesis.plugin.unitary\_synthesis\_plugin\_names[¶](#qiskit-transpiler-passes-synthesis-plugin-unitary-synthesis-plugin-names "Permalink to this headline") +# qiskit.transpiler.passes.synthesis.plugin.unitary\_synthesis\_plugin\_names -`unitary_synthesis_plugin_names()` +`unitary_synthesis_plugin_names()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/passes/synthesis/plugin.py "view source code") Return a list of installed unitary synthesis plugin names diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md index 8d6c6491254..b961b11ed3d 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check --- -# qiskit.transpiler.preset\_passmanagers.common.generate\_control\_flow\_options\_check[¶](#qiskit-transpiler-preset-passmanagers-common-generate-control-flow-options-check "Permalink to this headline") +# qiskit.transpiler.preset\_passmanagers.common.generate\_control\_flow\_options\_check -`generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None)` +`generate_control_flow_options_check(layout_method=None, routing_method=None, translation_method=None, optimization_method=None, scheduling_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pass manager that, when run on a DAG that contains control flow, fails with an error message explaining the invalid options, and what could be used instead. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md index 04fe40aa005..3577f57d722 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_embed_passmanager --- -# qiskit.transpiler.preset\_passmanagers.common.generate\_embed\_passmanager[¶](#qiskit-transpiler-preset-passmanagers-common-generate-embed-passmanager "Permalink to this headline") +# qiskit.transpiler.preset\_passmanagers.common.generate\_embed\_passmanager -`generate_embed_passmanager(coupling_map)` +`generate_embed_passmanager(coupling_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a layout embedding [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md index 3cef838e191..50b0183bcc7 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_error_on_control_flow --- -# qiskit.transpiler.preset\_passmanagers.common.generate\_error\_on\_control\_flow[¶](#qiskit-transpiler-preset-passmanagers-common-generate-error-on-control-flow "Permalink to this headline") +# qiskit.transpiler.preset\_passmanagers.common.generate\_error\_on\_control\_flow -`generate_error_on_control_flow(message)` +`generate_error_on_control_flow(message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Get a pass manager that always raises an error if control flow is present in a given circuit. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md index 71e2222e727..3046853434f 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_pre_op_passmanager --- -# qiskit.transpiler.preset\_passmanagers.common.generate\_pre\_op\_passmanager[¶](#qiskit-transpiler-preset-passmanagers-common-generate-pre-op-passmanager "Permalink to this headline") +# qiskit.transpiler.preset\_passmanagers.common.generate\_pre\_op\_passmanager -`generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)` +`generate_pre_op_passmanager(target=None, coupling_map=None, remove_reset_in_zero=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a pre-optimization loop [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md index dd0e695daeb..c857d4369c4 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_routing_passmanager --- -# qiskit.transpiler.preset\_passmanagers.common.generate\_routing\_passmanager[¶](#qiskit-transpiler-preset-passmanagers-common-generate-routing-passmanager "Permalink to this headline") +# qiskit.transpiler.preset\_passmanagers.common.generate\_routing\_passmanager -`generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True)` +`generate_routing_passmanager(routing_pass, target, coupling_map=None, vf2_call_limit=None, backend_properties=None, seed_transpiler=None, check_trivial=False, use_barrier_before_measurement=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a routing [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md index 4bdfc8e43ea..9305e8bbe94 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_scheduling.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_scheduling --- -# qiskit.transpiler.preset\_passmanagers.common.generate\_scheduling[¶](#qiskit-transpiler-preset-passmanagers-common-generate-scheduling "Permalink to this headline") +# qiskit.transpiler.preset\_passmanagers.common.generate\_scheduling -`generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map)` +`generate_scheduling(instruction_durations, scheduling_method, timing_constraints, inst_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a post optimization scheduling [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md index a0c0f8e3eb8..ee1cf236416 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_translation_passmanager --- -# qiskit.transpiler.preset\_passmanagers.common.generate\_translation\_passmanager[¶](#qiskit-transpiler-preset-passmanagers-common-generate-translation-passmanager "Permalink to this headline") +# qiskit.transpiler.preset\_passmanagers.common.generate\_translation\_passmanager -`generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` +`generate_translation_passmanager(target, basis_gates=None, method='translator', approximation_degree=None, coupling_map=None, backend_props=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate a basis translation [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md index e63e2f98348..51818ed723a 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.transpiler.preset_passmanagers.common.generate_unroll_3q --- -# qiskit.transpiler.preset\_passmanagers.common.generate\_unroll\_3q[¶](#qiskit-transpiler-preset-passmanagers-common-generate-unroll-3q "Permalink to this headline") +# qiskit.transpiler.preset\_passmanagers.common.generate\_unroll\_3q -`generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)` +`generate_unroll_3q(target, basis_gates=None, approximation_degree=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/common.py "view source code") Generate an unroll >3q [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md index 1d7376d1a84..7aea9ae57c8 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager --- -# qiskit.transpiler.preset\_passmanagers.generate\_preset\_pass\_manager[¶](#qiskit-transpiler-preset-passmanagers-generate-preset-pass-manager "Permalink to this headline") +# qiskit.transpiler.preset\_passmanagers.generate\_preset\_pass\_manager -`generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None)` +`generate_preset_pass_manager(optimization_level, backend=None, target=None, basis_gates=None, inst_map=None, coupling_map=None, instruction_durations=None, backend_properties=None, timing_constraints=None, initial_layout=None, layout_method=None, routing_method=None, translation_method=None, scheduling_method=None, approximation_degree=None, seed_transpiler=None, unitary_synthesis_method='default', unitary_synthesis_plugin_config=None, hls_config=None, init_method=None, optimization_method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/__init__.py "view source code") Generate a preset [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md index a224c1ef5a5..a0dda418fd9 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_0_pass_manager.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager --- -# qiskit.transpiler.preset\_passmanagers.level\_0\_pass\_manager[¶](#qiskit-transpiler-preset-passmanagers-level-0-pass-manager "Permalink to this headline") +# qiskit.transpiler.preset\_passmanagers.level\_0\_pass\_manager -`level_0_pass_manager(pass_manager_config)` +`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md index 7a89434af19..38cca4e2f22 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_1_pass_manager.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager --- -# qiskit.transpiler.preset\_passmanagers.level\_1\_pass\_manager[¶](#qiskit-transpiler-preset-passmanagers-level-1-pass-manager "Permalink to this headline") +# qiskit.transpiler.preset\_passmanagers.level\_1\_pass\_manager -`level_1_pass_manager(pass_manager_config)` +`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md index a9bc8e9056f..39231c12d04 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_2_pass_manager.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager --- -# qiskit.transpiler.preset\_passmanagers.level\_2\_pass\_manager[¶](#qiskit-transpiler-preset-passmanagers-level-2-pass-manager "Permalink to this headline") +# qiskit.transpiler.preset\_passmanagers.level\_2\_pass\_manager -`level_2_pass_manager(pass_manager_config)` +`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level2.py "view source code") Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md index 32fab5af89c..41c2dc88a0c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.level_3_pass_manager.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager --- -# qiskit.transpiler.preset\_passmanagers.level\_3\_pass\_manager[¶](#qiskit-transpiler-preset-passmanagers-level-3-pass-manager "Permalink to this headline") +# qiskit.transpiler.preset\_passmanagers.level\_3\_pass\_manager -`level_3_pass_manager(pass_manager_config)` +`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/level3.py "view source code") Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md index a8709ca95a4..0080a0e8f7c 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin --- -# PassManagerStagePlugin[¶](#passmanagerstageplugin "Permalink to this headline") +# PassManagerStagePlugin -`PassManagerStagePlugin` +`PassManagerStagePlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: `abc.ABC` @@ -24,7 +24,7 @@ A `PassManagerStagePlugin` object can be added to an external package and integr -`abstract PassManagerStagePlugin.pass_manager(pass_manager_config, optimization_level=None)` +`abstract PassManagerStagePlugin.pass_manager(pass_manager_config, optimization_level=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") This method is designed to return a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for the stage this implements diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md index 3c65b9e5e17..aa63be7fc5a 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePluginManager --- -# PassManagerStagePluginManager[¶](#passmanagerstagepluginmanager "Permalink to this headline") +# PassManagerStagePluginManager -`PassManagerStagePluginManager` +`PassManagerStagePluginManager`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Manager class for preset pass manager stage plugins. -`PassManagerStagePluginManager.get_passmanager_stage(stage_name, plugin_name, pm_config, optimization_level=None)` +`PassManagerStagePluginManager.get_passmanager_stage(stage_name, plugin_name, pm_config, optimization_level=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Get a stage diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md index 5d802338b85..5a9675b4640 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.transpiler.preset_passmanagers.plugin.list_stage_plugins --- -# qiskit.transpiler.preset\_passmanagers.plugin.list\_stage\_plugins[¶](#qiskit-transpiler-preset-passmanagers-plugin-list-stage-plugins "Permalink to this headline") +# qiskit.transpiler.preset\_passmanagers.plugin.list\_stage\_plugins -`list_stage_plugins(stage_name)` +`list_stage_plugins(stage_name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/preset_passmanagers/plugin.py "view source code") Get a list of installed plugins for a stage. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQC.md b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQC.md index 19665007353..76d9428b676 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQC.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQC.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.synthesis.aqc.AQC --- -# AQC[¶](#aqc "Permalink to this headline") +# AQC -`AQC(optimizer=None, seed=None)` +`AQC(optimizer=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Bases: `object` @@ -32,7 +32,7 @@ A generic implementation of Approximate Quantum Compiler. This implementation is -`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)` +`AQC.compile_unitary(target_matrix, approximate_circuit, approximating_objective, initial_point=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc.py "view source code") Approximately compiles a circuit represented as a unitary matrix by solving an optimization problem defined by `approximating_objective` and using `approximate_circuit` as a template for the approximate circuit. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md index b5742de62e8..3265c21d977 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin --- -# AQCSynthesisPlugin[¶](#aqcsynthesisplugin "Permalink to this headline") +# AQCSynthesisPlugin -`AQCSynthesisPlugin` +`AQCSynthesisPlugin`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Bases: [`qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") @@ -52,7 +52,7 @@ Initial values of angles/parameters to start the optimization process from. -`AQCSynthesisPlugin.run(unitary, **options)` +`AQCSynthesisPlugin.run(unitary, **options)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/aqc_plugin.py "view source code") Run synthesis for the given unitary matrix diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md index bd2e0d2b44e..2c282bcb320 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximateCircuit.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.synthesis.aqc.ApproximateCircuit --- -# ApproximateCircuit[¶](#approximatecircuit "Permalink to this headline") +# ApproximateCircuit -`ApproximateCircuit(num_qubits, name=None)` +`ApproximateCircuit(num_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: [`qiskit.circuit.quantumcircuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit"), `abc.ABC` @@ -27,7 +27,7 @@ A base class that represents an approximate circuit. -`abstract ApproximateCircuit.build(thetas)` +`abstract ApproximateCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") #### Constructs this circuit out of the parameters(thetas). Parameter values must be set before diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md index 94ab4fd1ecb..0554e706307 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.ApproximatingObjective.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.synthesis.aqc.ApproximatingObjective --- -# ApproximatingObjective[¶](#approximatingobjective "Permalink to this headline") +# ApproximatingObjective -`ApproximatingObjective` +`ApproximatingObjective`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Bases: `abc.ABC` @@ -22,7 +22,7 @@ A base class for an optimization problem definition. An implementing class must -`abstract ApproximatingObjective.gradient(param_values)` +`abstract ApproximatingObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -42,7 +42,7 @@ an array of gradient values. -`abstract ApproximatingObjective.objective(param_values)` +`abstract ApproximatingObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/approximate.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md index c3d57d032b6..d42a3f176ec 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitCircuit --- -# CNOTUnitCircuit[¶](#cnotunitcircuit "Permalink to this headline") +# CNOTUnitCircuit -`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)` +`CNOTUnitCircuit(num_qubits, cnots, tol=0.0, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit`](qiskit.transpiler.synthesis.aqc.ApproximateCircuit "qiskit.transpiler.synthesis.aqc.approximate.ApproximateCircuit") @@ -33,7 +33,7 @@ A class that represents an approximate circuit based on CNOT unit blocks. -`CNOTUnitCircuit.build(thetas)` +`CNOTUnitCircuit.build(thetas)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_circuit.py "view source code") #### Constructs a Qiskit quantum circuit out of the parameters (angles) of this circuit. If a diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md index 5557302cf8e..1f5c277f498 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.CNOTUnitObjective.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.synthesis.aqc.CNOTUnitObjective --- -# CNOTUnitObjective[¶](#cnotunitobjective "Permalink to this headline") +# CNOTUnitObjective -`CNOTUnitObjective(num_qubits, cnots)` +`CNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective`](qiskit.transpiler.synthesis.aqc.ApproximatingObjective "qiskit.transpiler.synthesis.aqc.approximate.ApproximatingObjective"), `abc.ABC` diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md index cc8833b04ed..95a96991071 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.synthesis.aqc.DefaultCNOTUnitObjective --- -# DefaultCNOTUnitObjective[¶](#defaultcnotunitobjective "Permalink to this headline") +# DefaultCNOTUnitObjective -`DefaultCNOTUnitObjective(num_qubits, cnots)` +`DefaultCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") @@ -27,7 +27,7 @@ A naive implementation of the objective function based on CNOT units. -`DefaultCNOTUnitObjective.gradient(param_values)` +`DefaultCNOTUnitObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a gradient with respect to parameters given a vector of parameter values. @@ -47,7 +47,7 @@ an array of gradient values. -`DefaultCNOTUnitObjective.objective(param_values)` +`DefaultCNOTUnitObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_unit_objective.py "view source code") Computes a value of the objective function given a vector of parameter values. diff --git a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md index 4eb5b3f42bc..6771c2c1d2f 100644 --- a/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md +++ b/docs/api/qiskit/0.41/qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.transpiler.synthesis.aqc.FastCNOTUnitObjective --- -# FastCNOTUnitObjective[¶](#fastcnotunitobjective "Permalink to this headline") +# FastCNOTUnitObjective -`FastCNOTUnitObjective(num_qubits, cnots)` +`FastCNOTUnitObjective(num_qubits, cnots)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") Bases: [`qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective`](qiskit.transpiler.synthesis.aqc.CNOTUnitObjective "qiskit.transpiler.synthesis.aqc.cnot_unit_objective.CNOTUnitObjective") @@ -27,7 +27,7 @@ Implementation of objective function and gradient calculator, which is similar t -`FastCNOTUnitObjective.gradient(param_values)` +`FastCNOTUnitObjective.gradient(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") Computes the gradient of objective function. See description of the base class method. @@ -39,7 +39,7 @@ Computes the gradient of objective function. See description of the base class m -`FastCNOTUnitObjective.objective(param_values)` +`FastCNOTUnitObjective.objective(param_values)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/fast_gradient/fast_gradient.py "view source code") Computes the objective function and some intermediate data for the subsequent gradient computation. See description of the base class method. diff --git a/docs/api/qiskit/0.41/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.41/qiskit.utils.QuantumInstance.md index c0f512e9c65..13a7db21a1d 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.41/qiskit.utils.QuantumInstance.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.utils.QuantumInstance --- -# QuantumInstance[¶](#quantuminstance "Permalink to this headline") +# QuantumInstance -`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)` +`QuantumInstance(backend, shots=None, seed_simulator=None, max_credits=None, basis_gates=None, coupling_map=None, initial_layout=None, pass_manager=None, bound_pass_manager=None, seed_transpiler=None, optimization_level=None, backend_options=None, noise_model=None, timeout=None, wait=5.0, skip_qobj_validation=True, measurement_error_mitigation_cls=None, cals_matrix_refresh_period=30, measurement_error_mitigation_shots=None, job_callback=None, mit_pattern=None, max_job_retries=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Bases: `object` @@ -55,7 +55,7 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu -`QuantumInstance.assemble(circuits)` +`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") assemble circuits @@ -67,7 +67,7 @@ assemble circuits -`QuantumInstance.cals_matrix(qubit_index=None)` +`QuantumInstance.cals_matrix(qubit_index=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Get the stored calibration matrices and its timestamp. @@ -87,7 +87,7 @@ The calibration matrix and the creation timestamp if qubit\_index is not None ot -`QuantumInstance.execute(circuits, had_transpiled=False)` +`QuantumInstance.execute(circuits, had_transpiled=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") A wrapper to interface with quantum backend. @@ -118,7 +118,7 @@ assembling to the qobj. -`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)` +`QuantumInstance.maybe_refresh_cals_matrix(timestamp=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Calculate the time difference from the query of last time. @@ -138,7 +138,7 @@ Whether or not refresh the cals\_matrix -`QuantumInstance.reset_execution_results()` +`QuantumInstance.reset_execution_results()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Reset execution results @@ -150,7 +150,7 @@ Reset execution results -`QuantumInstance.set_config(**kwargs)` +`QuantumInstance.set_config(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") Set configurations for the quantum instance. @@ -158,7 +158,7 @@ Set configurations for the quantum instance. -`QuantumInstance.transpile(circuits, pass_manager=None)` +`QuantumInstance.transpile(circuits, pass_manager=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/quantum_instance.py "view source code") A wrapper to transpile circuits to allow algorithm access the transpiled circuits. diff --git a/docs/api/qiskit/0.41/qiskit.utils.algorithm_globals.md b/docs/api/qiskit/0.41/qiskit.utils.algorithm_globals.md index f806386d5fd..5c290b1f4dc 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.algorithm_globals.md +++ b/docs/api/qiskit/0.41/qiskit.utils.algorithm_globals.md @@ -1,4 +1,4 @@ -# qiskit.utils.algorithm\_globals[¶](#qiskit-utils-algorithm-globals "Permalink to this headline") +# qiskit.utils.algorithm\_globals ## algorithm\_globals *= \* diff --git a/docs/api/qiskit/0.41/qiskit.utils.apply_prefix.md b/docs/api/qiskit/0.41/qiskit.utils.apply_prefix.md index 4ce3f95827b..18e4bc1cafd 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.41/qiskit.utils.apply_prefix.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.utils.apply_prefix --- -# qiskit.utils.apply\_prefix[¶](#qiskit-utils-apply-prefix "Permalink to this headline") +# qiskit.utils.apply\_prefix -`apply_prefix(value, unit)` +`apply_prefix(value, unit)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/units.py "view source code") Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. diff --git a/docs/api/qiskit/0.41/qiskit.utils.deprecate_arguments.md b/docs/api/qiskit/0.41/qiskit.utils.deprecate_arguments.md index 01185eff4a2..48db8a0fa56 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.41/qiskit.utils.deprecate_arguments.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.utils.deprecate_arguments --- -# qiskit.utils.deprecate\_arguments[¶](#qiskit-utils-deprecate-arguments "Permalink to this headline") +# qiskit.utils.deprecate\_arguments -`deprecate_arguments(kwarg_map, category=)` +`deprecate_arguments(kwarg_map, category=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/deprecation.py "view source code") Decorator to automatically alias deprecated argument names and warn upon use. diff --git a/docs/api/qiskit/0.41/qiskit.utils.deprecate_function.md b/docs/api/qiskit/0.41/qiskit.utils.deprecate_function.md index f51f9e9eebc..26966ec6081 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.41/qiskit.utils.deprecate_function.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.utils.deprecate_function --- -# qiskit.utils.deprecate\_function[¶](#qiskit-utils-deprecate-function "Permalink to this headline") +# qiskit.utils.deprecate\_function -`deprecate_function(msg, stacklevel=2, category=)` +`deprecate_function(msg, stacklevel=2, category=)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/deprecation.py "view source code") Emit a warning prior to calling decorated function. diff --git a/docs/api/qiskit/0.41/qiskit.utils.detach_prefix.md b/docs/api/qiskit/0.41/qiskit.utils.detach_prefix.md index cb0c5f25999..aa6ae361868 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.detach_prefix.md +++ b/docs/api/qiskit/0.41/qiskit.utils.detach_prefix.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.utils.detach_prefix --- -# qiskit.utils.detach\_prefix[¶](#qiskit-utils-detach-prefix "Permalink to this headline") +# qiskit.utils.detach\_prefix -`detach_prefix(value, decimal=None)` +`detach_prefix(value, decimal=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/units.py "view source code") Given a SI unit value, find the most suitable prefix to scale the value. diff --git a/docs/api/qiskit/0.41/qiskit.utils.get_entangler_map.md b/docs/api/qiskit/0.41/qiskit.utils.get_entangler_map.md index 034e60e612f..eb57125b4f7 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.get_entangler_map.md +++ b/docs/api/qiskit/0.41/qiskit.utils.get_entangler_map.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.utils.get_entangler_map --- -# qiskit.utils.get\_entangler\_map[¶](#qiskit-utils-get-entangler-map "Permalink to this headline") +# qiskit.utils.get\_entangler\_map -`get_entangler_map(map_type, num_qubits, offset=0)` +`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. diff --git a/docs/api/qiskit/0.41/qiskit.utils.has_aer.md b/docs/api/qiskit/0.41/qiskit.utils.has_aer.md index 5f0343e0e34..ee3848bebff 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.41/qiskit.utils.has_aer.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.utils.has_aer --- -# qiskit.utils.has\_aer[¶](#qiskit-utils-has-aer "Permalink to this headline") +# qiskit.utils.has\_aer -`has_aer()` +`has_aer()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/backend_utils.py "view source code") check if Aer is installed diff --git a/docs/api/qiskit/0.41/qiskit.utils.has_ibmq.md b/docs/api/qiskit/0.41/qiskit.utils.has_ibmq.md index 92c35ba8720..63a48b4f364 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.41/qiskit.utils.has_ibmq.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.utils.has_ibmq --- -# qiskit.utils.has\_ibmq[¶](#qiskit-utils-has-ibmq "Permalink to this headline") +# qiskit.utils.has\_ibmq -`has_ibmq()` +`has_ibmq()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/backend_utils.py "view source code") Check if IBMQ is installed diff --git a/docs/api/qiskit/0.41/qiskit.utils.is_main_process.md b/docs/api/qiskit/0.41/qiskit.utils.is_main_process.md index 4732cc877a9..a77586ad017 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.is_main_process.md +++ b/docs/api/qiskit/0.41/qiskit.utils.is_main_process.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.utils.is_main_process --- -# qiskit.utils.is\_main\_process[¶](#qiskit-utils-is-main-process "Permalink to this headline") +# qiskit.utils.is\_main\_process -`is_main_process()` +`is_main_process()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/multiprocessing.py "view source code") Checks whether the current process is the main one diff --git a/docs/api/qiskit/0.41/qiskit.utils.local_hardware_info.md b/docs/api/qiskit/0.41/qiskit.utils.local_hardware_info.md index 769c1ce8a22..d52fb33fc04 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.local_hardware_info.md +++ b/docs/api/qiskit/0.41/qiskit.utils.local_hardware_info.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.utils.local_hardware_info --- -# qiskit.utils.local\_hardware\_info[¶](#qiskit-utils-local-hardware-info "Permalink to this headline") +# qiskit.utils.local\_hardware\_info -`local_hardware_info()` +`local_hardware_info()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/multiprocessing.py "view source code") Basic hardware information about the local machine. diff --git a/docs/api/qiskit/0.41/qiskit.utils.mitigation.CompleteMeasFitter.md b/docs/api/qiskit/0.41/qiskit.utils.mitigation.CompleteMeasFitter.md index 851767755ad..58df10dae46 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.41/qiskit.utils.mitigation.CompleteMeasFitter.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.utils.mitigation.CompleteMeasFitter --- -# CompleteMeasFitter[¶](#completemeasfitter "Permalink to this headline") +# CompleteMeasFitter -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` +`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -37,7 +37,7 @@ A wrapper for the tensored fitter -`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` +`CompleteMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -50,7 +50,7 @@ Add measurement calibration data -`CompleteMeasFitter.readout_fidelity(label_list=None)` +`CompleteMeasFitter.readout_fidelity(label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix @@ -74,7 +74,7 @@ The on-diagonal elements of the calibration matrix are the probabilities of meas -`CompleteMeasFitter.subset_fitter(qubit_sublist)` +`CompleteMeasFitter.subset_fitter(qubit_sublist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.41/qiskit.utils.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.41/qiskit.utils.mitigation.TensoredMeasFitter.md index 421d1a416b6..3652cadf5e8 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.41/qiskit.utils.mitigation.TensoredMeasFitter.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.utils.mitigation.TensoredMeasFitter --- -# TensoredMeasFitter[¶](#tensoredmeasfitter "Permalink to this headline") +# TensoredMeasFitter -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` +`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Bases: `object` @@ -39,7 +39,7 @@ Initialize a measurement calibration matrix from the results of running the circ -`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)` +`TensoredMeasFitter.add_data(new_results, rebuild_cal_matrix=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Add measurement calibration data @@ -52,7 +52,7 @@ Add measurement calibration data -`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)` +`TensoredMeasFitter.readout_fidelity(cal_index=0, label_list=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. @@ -81,7 +81,7 @@ The on-diagonal elements of the calibration matrices are the probabilities of me -`TensoredMeasFitter.subset_fitter(qubit_sublist)` +`TensoredMeasFitter.subset_fitter(qubit_sublist)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/mitigation/fitters.py "view source code") Return a fitter object that is a subset of the qubits in the original list. diff --git a/docs/api/qiskit/0.41/qiskit.utils.name_args.md b/docs/api/qiskit/0.41/qiskit.utils.name_args.md index 8a670f27793..6be1349c741 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.41/qiskit.utils.name_args.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.utils.name_args --- -# qiskit.utils.name\_args[¶](#qiskit-utils-name-args "Permalink to this headline") +# qiskit.utils.name\_args -`name_args(mapping, skip=0)` +`name_args(mapping, skip=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/name_unnamed_args.py "view source code") Decorator to convert unnamed arguments to named ones. diff --git a/docs/api/qiskit/0.41/qiskit.utils.summarize_circuits.md b/docs/api/qiskit/0.41/qiskit.utils.summarize_circuits.md index e172118e3ae..0b1d9a1e7bf 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.41/qiskit.utils.summarize_circuits.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.utils.summarize_circuits --- -# qiskit.utils.summarize\_circuits[¶](#qiskit-utils-summarize-circuits "Permalink to this headline") +# qiskit.utils.summarize\_circuits -`summarize_circuits(circuits)` +`summarize_circuits(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/circuit_utils.py "view source code") ## Summarize circuits based on QuantumCircuit, and five metrics are summarized. diff --git a/docs/api/qiskit/0.41/qiskit.utils.validate_entangler_map.md b/docs/api/qiskit/0.41/qiskit.utils.validate_entangler_map.md index d88fd78abd7..a1e0f8b0677 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.validate_entangler_map.md +++ b/docs/api/qiskit/0.41/qiskit.utils.validate_entangler_map.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.utils.validate_entangler_map --- -# qiskit.utils.validate\_entangler\_map[¶](#qiskit-utils-validate-entangler-map "Permalink to this headline") +# qiskit.utils.validate\_entangler\_map -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. diff --git a/docs/api/qiskit/0.41/qiskit.utils.wrap_method.md b/docs/api/qiskit/0.41/qiskit.utils.wrap_method.md index f0d5feb02d1..5fa0d0601de 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.wrap_method.md +++ b/docs/api/qiskit/0.41/qiskit.utils.wrap_method.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.utils.wrap_method --- -# qiskit.utils.wrap\_method[¶](#qiskit-utils-wrap-method "Permalink to this headline") +# qiskit.utils.wrap\_method -`wrap_method(cls, name, *, before=None, after=None)` +`wrap_method(cls, name, *, before=None, after=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/classtools.py "view source code") Wrap the functionality the instance- or class method `cls.name` with additional behaviour `before` and `after`. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.41/qiskit.visualization.VisualizationError.md index 118291b5a99..d9c3c13769e 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.VisualizationError.md @@ -6,11 +6,11 @@ python_api_type: exception python_api_name: qiskit.visualization.VisualizationError --- -# qiskit.visualization.VisualizationError[¶](#qiskit-visualization-visualizationerror "Permalink to this headline") +# qiskit.visualization.VisualizationError -`VisualizationError(*message)` +`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.array_to_latex.md b/docs/api/qiskit/0.41/qiskit.visualization.array_to_latex.md index 8ca00273d8c..8f5384af8ba 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.array_to_latex.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.array_to_latex.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.visualization.array_to_latex --- -# qiskit.visualization.array\_to\_latex[¶](#qiskit-visualization-array-to-latex "Permalink to this headline") +# qiskit.visualization.array\_to\_latex -`array_to_latex(array, precision=10, prefix='', source=False, max_size=8)` +`array_to_latex(array, precision=10, prefix='', source=False, max_size=8)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/array.py "view source code") Latex representation of a complex numpy array (with dimension 1 or 2) diff --git a/docs/api/qiskit/0.41/qiskit.visualization.circuit_drawer.md b/docs/api/qiskit/0.41/qiskit.visualization.circuit_drawer.md index 30387487701..af1b9d7162d 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.circuit_drawer.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.visualization.circuit_drawer --- -# qiskit.visualization.circuit\_drawer[¶](#qiskit-visualization-circuit-drawer "Permalink to this headline") +# qiskit.visualization.circuit\_drawer -`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)` +`circuit_drawer(circuit, scale=None, filename=None, style=None, output=None, interactive=False, plot_barriers=True, reverse_bits=None, justify=None, vertical_compression='medium', idle_wires=True, with_layout=True, fold=None, ax=None, initial_state=False, cregbundle=None, wire_order=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/circuit/circuit_visualization.py "view source code") Draw the quantum circuit. Use the output parameter to choose the drawing format: diff --git a/docs/api/qiskit/0.41/qiskit.visualization.dag_drawer.md b/docs/api/qiskit/0.41/qiskit.visualization.dag_drawer.md index dad2a8dc3c7..80f7eea6109 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.dag_drawer.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.visualization.dag_drawer --- -# qiskit.visualization.dag\_drawer[¶](#qiskit-visualization-dag-drawer "Permalink to this headline") +# qiskit.visualization.dag\_drawer -`dag_drawer(dag, scale=0.7, filename=None, style='color')` +`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.pass_manager_drawer.md b/docs/api/qiskit/0.41/qiskit.visualization.pass_manager_drawer.md index d1f64c94e6b..66037e69917 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.pass_manager_drawer.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.pass_manager_drawer.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.visualization.pass_manager_drawer --- -# qiskit.visualization.pass\_manager\_drawer[¶](#qiskit-visualization-pass-manager-drawer "Permalink to this headline") +# qiskit.visualization.pass\_manager\_drawer -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_bloch_multivector.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_bloch_multivector.md index 9ee93709a59..cb05ba3ea65 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_bloch_multivector.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_bloch_multivector.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.visualization.plot_bloch_multivector --- -# qiskit.visualization.plot\_bloch\_multivector[¶](#qiskit-visualization-plot-bloch-multivector "Permalink to this headline") +# qiskit.visualization.plot\_bloch\_multivector -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)` +`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot a Bloch sphere for each qubit. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_bloch_vector.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_bloch_vector.md index b1674c2cd6c..2460f3f5c86 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_bloch_vector.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_bloch_vector.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.visualization.plot_bloch_vector --- -# qiskit.visualization.plot\_bloch\_vector[¶](#qiskit-visualization-plot-bloch-vector "Permalink to this headline") +# qiskit.visualization.plot\_bloch\_vector -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_circuit_layout.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_circuit_layout.md index 9da12696105..89c1bf82695 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_circuit_layout.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_circuit_layout.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.visualization.plot_circuit_layout --- -# qiskit.visualization.plot\_circuit\_layout[¶](#qiskit-visualization-plot-circuit-layout "Permalink to this headline") +# qiskit.visualization.plot\_circuit\_layout -`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)` +`plot_circuit_layout(circuit, backend, view='virtual', qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") Plot the layout of a circuit transpiled for a given target backend. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_coupling_map.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_coupling_map.md index aa7b08f8460..1adc5a0004a 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_coupling_map.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_coupling_map.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.visualization.plot_coupling_map --- -# qiskit.visualization.plot\_coupling\_map[¶](#qiskit-visualization-plot-coupling-map "Permalink to this headline") +# qiskit.visualization.plot\_coupling\_map -`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)` +`plot_coupling_map(num_qubits, qubit_coordinates, coupling_map, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") Plots an arbitrary coupling map of qubits (embedded in a plane). diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_distribution.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_distribution.md index 916b2a66e4a..b7e7901800d 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_distribution.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_distribution.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.visualization.plot_distribution --- -# qiskit.visualization.plot\_distribution[¶](#qiskit-visualization-plot-distribution "Permalink to this headline") +# qiskit.visualization.plot\_distribution -`plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` +`plot_distribution(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/counts_visualization.py "view source code") Plot a distribution from input sampled data. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_error_map.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_error_map.md index af45df2892e..f3cd7a830f8 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_error_map.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_error_map.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.visualization.plot_error_map --- -# qiskit.visualization.plot\_error\_map[¶](#qiskit-visualization-plot-error-map "Permalink to this headline") +# qiskit.visualization.plot\_error\_map -`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)` +`plot_error_map(backend, figsize=(12, 9), show_title=True, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") Plots the error map of a given backend. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_gate_map.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_gate_map.md index 42834dad901..e4348af001c 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_gate_map.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_gate_map.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.visualization.plot_gate_map --- -# qiskit.visualization.plot\_gate\_map[¶](#qiskit-visualization-plot-gate-map "Permalink to this headline") +# qiskit.visualization.plot\_gate\_map -`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)` +`plot_gate_map(backend, figsize=None, plot_directed=False, label_qubits=True, qubit_size=None, line_width=4, font_size=None, qubit_color=None, qubit_labels=None, line_color=None, font_color='w', ax=None, filename=None, qubit_coordinates=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/gate_map.py "view source code") Plots the gate map of a device. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_histogram.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_histogram.md index 7f86682b83f..36d287cb0fe 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_histogram.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.visualization.plot_histogram --- -# qiskit.visualization.plot\_histogram[¶](#qiskit-visualization-plot-histogram "Permalink to this headline") +# qiskit.visualization.plot\_histogram -`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)` +`plot_histogram(data, figsize=(7, 5), color=None, number_to_keep=None, sort='asc', target_string=None, legend=None, bar_labels=True, title=None, ax=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/counts_visualization.py "view source code") Plot a histogram of input counts data. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_state_city.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_state_city.md index 495b357e775..d7d3f8e310a 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_state_city.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_state_city.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.visualization.plot_state_city --- -# qiskit.visualization.plot\_state\_city[¶](#qiskit-visualization-plot-state-city "Permalink to this headline") +# qiskit.visualization.plot\_state\_city -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)` +`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot the cityscape of quantum state. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_state_hinton.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_state_hinton.md index 6c3da1b9d09..c8b49df15bc 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_state_hinton.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_state_hinton.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.visualization.plot_state_hinton --- -# qiskit.visualization.plot\_state\_hinton[¶](#qiskit-visualization-plot-state-hinton "Permalink to this headline") +# qiskit.visualization.plot\_state\_hinton -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)` +`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot a hinton diagram for the density matrix of a quantum state. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_state_paulivec.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_state_paulivec.md index 9a9702dde21..f66c35a7ac0 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_state_paulivec.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_state_paulivec.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.visualization.plot_state_paulivec --- -# qiskit.visualization.plot\_state\_paulivec[¶](#qiskit-visualization-plot-state-paulivec "Permalink to this headline") +# qiskit.visualization.plot\_state\_paulivec -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)` +`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot the paulivec representation of a quantum state. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.plot_state_qsphere.md b/docs/api/qiskit/0.41/qiskit.visualization.plot_state_qsphere.md index 17250e883b7..4d7e14b213f 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.plot_state_qsphere.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.plot_state_qsphere.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.visualization.plot_state_qsphere --- -# qiskit.visualization.plot\_state\_qsphere[¶](#qiskit-visualization-plot-state-qsphere "Permalink to this headline") +# qiskit.visualization.plot\_state\_qsphere -`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)` +`plot_state_qsphere(state, figsize=None, ax=None, show_state_labels=True, show_state_phases=False, use_degrees=False, *, rho=None, filename=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/state_visualization.py "view source code") Plot the qsphere representation of a quantum state. Here, the size of the points is proportional to the probability of the corresponding term in the state and the color represents the phase. diff --git a/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXDebugging.md b/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXDebugging.md index 64900409296..4be541bcafe 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXDebugging.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXDebugging.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.visualization.pulse.IQXDebugging --- -# IQXDebugging[¶](#iqxdebugging "Permalink to this headline") +# IQXDebugging -`IQXDebugging(**kwargs)` +`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXSimple.md b/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXSimple.md index e802d7a53cb..0abf720b463 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXSimple.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXSimple.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.visualization.pulse.IQXSimple --- -# IQXSimple[¶](#iqxsimple "Permalink to this headline") +# IQXSimple -`IQXSimple(**kwargs)` +`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXStandard.md b/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXStandard.md index c7149c045f9..192b14169dd 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXStandard.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.pulse.IQXStandard.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.visualization.pulse.IQXStandard --- -# IQXStandard[¶](#iqxstandard "Permalink to this headline") +# IQXStandard -`IQXStandard(**kwargs)` +`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` diff --git a/docs/api/qiskit/0.41/qiskit.visualization.pulse_drawer.md b/docs/api/qiskit/0.41/qiskit.visualization.pulse_drawer.md index 26b0ae06698..113f5cbe5ba 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.pulse_drawer.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.pulse_drawer.md @@ -6,7 +6,7 @@ python_api_type: function python_api_name: qiskit.visualization.pulse_drawer --- -# qiskit.visualization.pulse\_drawer[¶](#qiskit-visualization-pulse-drawer "Permalink to this headline") +# qiskit.visualization.pulse\_drawer diff --git a/docs/api/qiskit/0.41/qiskit.visualization.qcstyle.DefaultStyle.md b/docs/api/qiskit/0.41/qiskit.visualization.qcstyle.DefaultStyle.md index 18a2fec0e0a..02cf563453c 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.qcstyle.DefaultStyle.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit.visualization.qcstyle.DefaultStyle --- -# DefaultStyle[¶](#defaultstyle "Permalink to this headline") +# DefaultStyle -`DefaultStyle` +`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/circuit/qcstyle.py "view source code") Bases: `object` diff --git a/docs/api/qiskit/0.41/qiskit.visualization.timeline_drawer.md b/docs/api/qiskit/0.41/qiskit.visualization.timeline_drawer.md index e58f0407c3c..889de8ee2f3 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.timeline_drawer.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.timeline_drawer.md @@ -6,7 +6,7 @@ python_api_type: function python_api_name: qiskit.visualization.timeline_drawer --- -# qiskit.visualization.timeline\_drawer[¶](#qiskit-visualization-timeline-drawer "Permalink to this headline") +# qiskit.visualization.timeline\_drawer diff --git a/docs/api/qiskit/0.41/qiskit.visualization.visualize_transition.md b/docs/api/qiskit/0.41/qiskit.visualization.visualize_transition.md index 09e5f8ce3dd..321fbb35f33 100644 --- a/docs/api/qiskit/0.41/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.41/qiskit.visualization.visualize_transition.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit.visualization.visualize_transition --- -# qiskit.visualization.visualize\_transition[¶](#qiskit-visualization-visualize-transition "Permalink to this headline") +# qiskit.visualization.visualize\_transition -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. diff --git a/docs/api/qiskit/0.41/qiskit_aer.AerError.md b/docs/api/qiskit/0.41/qiskit_aer.AerError.md index ce6533327cb..5f4c2607a79 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.AerError.md +++ b/docs/api/qiskit/0.41/qiskit_aer.AerError.md @@ -6,11 +6,11 @@ python_api_type: exception python_api_name: qiskit_aer.AerError --- -# qiskit\_aer.AerError[¶](#qiskit-aer-aererror "Permalink to this headline") +# qiskit\_aer.AerError -`AerError(*message)` +`AerError(*message)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aererror.py "view source code") Base class for errors raised by simulators. diff --git a/docs/api/qiskit/0.41/qiskit_aer.AerProvider.md b/docs/api/qiskit/0.41/qiskit_aer.AerProvider.md index 3c6a26dbb41..4f6b0e4db92 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.AerProvider.md +++ b/docs/api/qiskit/0.41/qiskit_aer.AerProvider.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.AerProvider --- -# AerProvider[¶](#aerprovider "Permalink to this headline") +# AerProvider -`AerProvider` +`AerProvider`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") Bases: [`qiskit.providers.provider.ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.provider.ProviderV1") @@ -22,7 +22,7 @@ Provider for Qiskit Aer backends. -`AerProvider.backends(name=None, filters=None, **kwargs)` +`AerProvider.backends(name=None, filters=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") Return a list of backends matching the specified filtering. @@ -45,7 +45,7 @@ list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] -`AerProvider.get_backend(name=None, **kwargs)` +`AerProvider.get_backend(name=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/aerprovider.py "view source code") Return a single backend matching the specified filtering. diff --git a/docs/api/qiskit/0.41/qiskit_aer.AerSimulator.md b/docs/api/qiskit/0.41/qiskit_aer.AerSimulator.md index cdd03985817..47bc8a665dc 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.AerSimulator.md +++ b/docs/api/qiskit/0.41/qiskit_aer.AerSimulator.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.AerSimulator --- -# AerSimulator[¶](#aersimulator "Permalink to this headline") +# AerSimulator -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -205,7 +205,7 @@ This method should initialize the module and its configuration, and raise an exc -`AerSimulator.available_devices()` +`AerSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -213,7 +213,7 @@ Return the available simulation methods. -`AerSimulator.available_methods()` +`AerSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Return the available simulation methods. @@ -229,7 +229,7 @@ Reset the simulator options to default values. -`AerSimulator.configuration()` +`AerSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Return the simulator backend configuration. @@ -263,7 +263,7 @@ backend does not support pulse. -`classmethod AerSimulator.from_backend(backend, **options)` +`classmethod AerSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Initialize simulator from backend. @@ -271,7 +271,7 @@ Initialize simulator from backend. -`AerSimulator.name()` +`AerSimulator.name()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Format backend name string for simulator @@ -359,7 +359,7 @@ The simulation job. -`AerSimulator.set_option(key, value)` +`AerSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/aer_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.41/qiskit_aer.PulseSimulator.md b/docs/api/qiskit/0.41/qiskit_aer.PulseSimulator.md index cac991bb628..7fcf1526bba 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.PulseSimulator.md +++ b/docs/api/qiskit/0.41/qiskit_aer.PulseSimulator.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.PulseSimulator --- -# PulseSimulator[¶](#pulsesimulator "Permalink to this headline") +# PulseSimulator -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -149,7 +149,7 @@ backend does not support pulse. -`classmethod PulseSimulator.from_backend(backend, **options)` +`classmethod PulseSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Initialize simulator from backend. @@ -207,7 +207,7 @@ the Provider responsible for the backend. -`PulseSimulator.run(schedules, validate=True, **run_options)` +`PulseSimulator.run(schedules, validate=True, **run_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Run a qobj on the backend. @@ -233,7 +233,7 @@ The simulation job. -`PulseSimulator.set_option(key, value)` +`PulseSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/pulse_simulator.py "view source code") Set pulse simulation options and update backend. diff --git a/docs/api/qiskit/0.41/qiskit_aer.QasmSimulator.md b/docs/api/qiskit/0.41/qiskit_aer.QasmSimulator.md index 9446d9baa8f..41467bd0e1c 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.QasmSimulator.md +++ b/docs/api/qiskit/0.41/qiskit_aer.QasmSimulator.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.QasmSimulator --- -# QasmSimulator[¶](#qasmsimulator "Permalink to this headline") +# QasmSimulator -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -140,7 +140,7 @@ This method should initialize the module and its configuration, and raise an exc -`QasmSimulator.available_devices()` +`QasmSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -148,7 +148,7 @@ Return the available simulation methods. -`QasmSimulator.available_methods()` +`QasmSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Return the available simulation methods. @@ -164,7 +164,7 @@ Reset the simulator options to default values. -`QasmSimulator.configuration()` +`QasmSimulator.configuration()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Return the simulator backend configuration. @@ -198,7 +198,7 @@ backend does not support pulse. -`classmethod QasmSimulator.from_backend(backend, **options)` +`classmethod QasmSimulator.from_backend(backend, **options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Initialize simulator from backend. @@ -302,7 +302,7 @@ The simulation job. -`QasmSimulator.set_option(key, value)` +`QasmSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/qasm_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.41/qiskit_aer.StatevectorSimulator.md b/docs/api/qiskit/0.41/qiskit_aer.StatevectorSimulator.md index 6fa5fa9d7be..32eeaabdfc3 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.41/qiskit_aer.StatevectorSimulator.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.StatevectorSimulator --- -# StatevectorSimulator[¶](#statevectorsimulator "Permalink to this headline") +# StatevectorSimulator -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -74,7 +74,7 @@ This method should initialize the module and its configuration, and raise an exc -`StatevectorSimulator.available_devices()` +`StatevectorSimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -82,7 +82,7 @@ Return the available simulation methods. -`StatevectorSimulator.available_methods()` +`StatevectorSimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Return the available simulation methods. @@ -228,7 +228,7 @@ The simulation job. -`StatevectorSimulator.set_option(key, value)` +`StatevectorSimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/statevector_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.41/qiskit_aer.UnitarySimulator.md b/docs/api/qiskit/0.41/qiskit_aer.UnitarySimulator.md index 03faa061c61..1f06420d096 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.41/qiskit_aer.UnitarySimulator.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.UnitarySimulator --- -# UnitarySimulator[¶](#unitarysimulator "Permalink to this headline") +# UnitarySimulator -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Bases: `qiskit_aer.backends.aerbackend.AerBackend` @@ -75,7 +75,7 @@ This method should initialize the module and its configuration, and raise an exc -`UnitarySimulator.available_devices()` +`UnitarySimulator.available_devices()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -83,7 +83,7 @@ Return the available simulation methods. -`UnitarySimulator.available_methods()` +`UnitarySimulator.available_methods()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Return the available simulation methods. @@ -229,7 +229,7 @@ The simulation job. -`UnitarySimulator.set_option(key, value)` +`UnitarySimulator.set_option(key, value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/backends/unitary_simulator.py "view source code") Special handling for setting backend options. diff --git a/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJob.md b/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJob.md index 5d06f4c59a7..db313fa15b5 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJob.md +++ b/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJob.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.jobs.AerJob --- -# AerJob[¶](#aerjob "Permalink to this headline") +# AerJob -`AerJob(backend, job_id, fn, qobj, executor=None)` +`AerJob(backend, job_id, fn, qobj, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -32,7 +32,7 @@ Initializes the asynchronous job. -`AerJob.backend()` +`AerJob.backend()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Return the instance of the backend used for this job. @@ -40,7 +40,7 @@ Return the instance of the backend used for this job. -`AerJob.cancel()` +`AerJob.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Attempt to cancel the job. @@ -72,7 +72,7 @@ Return whether the job has successfully run. -`AerJob.executor()` +`AerJob.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Return the executor for this job @@ -104,7 +104,7 @@ Return a unique id identifying the job. -`AerJob.qobj()` +`AerJob.qobj()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Return the Qobj submitted for this job. @@ -120,7 +120,7 @@ the Qobj submitted for this job. -`AerJob.result(timeout=None)` +`AerJob.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Get job result. The behavior is the same as the underlying concurrent Future objects, @@ -159,7 +159,7 @@ Return whether the job is actively running. -`AerJob.status()` +`AerJob.status()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Gets the status of the job by querying the Python’s future @@ -180,7 +180,7 @@ The current JobStatus -`AerJob.submit()` +`AerJob.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjob.py "view source code") Submit the job to the backend for execution. diff --git a/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJobSet.md b/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJobSet.md index 78b12814293..36f087d4664 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJobSet.md +++ b/docs/api/qiskit/0.41/qiskit_aer.jobs.AerJobSet.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.jobs.AerJobSet --- -# AerJobSet[¶](#aerjobset "Permalink to this headline") +# AerJobSet -`AerJobSet(backend, job_id, fn, experiments, executor=None)` +`AerJobSet(backend, job_id, fn, experiments, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Bases: [`qiskit.providers.job.JobV1`](qiskit.providers.JobV1 "qiskit.providers.job.JobV1") @@ -46,7 +46,7 @@ Return the backend where this job was executed. -`AerJobSet.cancel()` +`AerJobSet.cancel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Cancel all jobs in this job set. @@ -82,7 +82,7 @@ Return whether the job has successfully run. -`AerJobSet.executor()` +`AerJobSet.executor()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the executor for this job @@ -102,7 +102,7 @@ Return whether the job is in a final job state such as `DONE` or `ERROR`. -`AerJobSet.job(experiment)` +`AerJobSet.job(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Retrieve the job used to submit the specified experiment and its index. @@ -144,7 +144,7 @@ Return a unique id identifying the job. -`AerJobSet.result(timeout=None)` +`AerJobSet.result(timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the results of the jobs as a single Result object. @@ -182,7 +182,7 @@ Return whether the job is actively running. -`AerJobSet.status(worker)` +`AerJobSet.status(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the status of each job in this set. @@ -202,7 +202,7 @@ A list of job statuses. -`AerJobSet.submit()` +`AerJobSet.submit()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Execute this set of jobs on an executor. @@ -246,7 +246,7 @@ Poll the job status until it progresses to a final state such as `DONE` or `ERRO -`AerJobSet.worker(experiment)` +`AerJobSet.worker(experiment)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Retrieve the index of job. @@ -276,7 +276,7 @@ list or integer value of the job id -`AerJobSet.worker_job(worker)` +`AerJobSet.worker_job(worker)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Retrieve the job specified with job’s id @@ -300,7 +300,7 @@ A list of `AerJob` instances that represents the submitted jobs. -`AerJobSet.worker_results(worker, timeout=None)` +`AerJobSet.worker_results(worker, timeout=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/jobs/aerjobset.py "view source code") Return the result of the jobs specified with worker\_id. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudes.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudes.md index 128ed59acb4..a6a3c1ee847 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudes.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudes.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SaveAmplitudes --- -# SaveAmplitudes[¶](#saveamplitudes "Permalink to this headline") +# SaveAmplitudes -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudesSquared.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudesSquared.md index e0ebe2a2f1c..dbe9b362161 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudesSquared.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveAmplitudesSquared.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SaveAmplitudesSquared --- -# SaveAmplitudesSquared[¶](#saveamplitudessquared "Permalink to this headline") +# SaveAmplitudesSquared -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveClifford.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveClifford.md index 2952bcf5a54..61c035747e2 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveClifford.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveClifford.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SaveClifford --- -# SaveClifford[¶](#saveclifford "Permalink to this headline") +# SaveClifford -`SaveClifford(num_qubits, label='clifford', pershot=False)` +`SaveClifford(num_qubits, label='clifford', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_clifford.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveDensityMatrix.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveDensityMatrix.md index 109a1efd8eb..a97970dec60 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveDensityMatrix.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveDensityMatrix.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SaveDensityMatrix --- -# SaveDensityMatrix[¶](#savedensitymatrix "Permalink to this headline") +# SaveDensityMatrix -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValue.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValue.md index af84742fcf3..4f170429cb8 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValue.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValue.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SaveExpectationValue --- -# SaveExpectationValue[¶](#saveexpectationvalue "Permalink to this headline") +# SaveExpectationValue -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValueVariance.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValueVariance.md index 5d74ac786f4..b65cc654c01 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValueVariance.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveExpectationValueVariance.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SaveExpectationValueVariance --- -# SaveExpectationValueVariance[¶](#saveexpectationvaluevariance "Permalink to this headline") +# SaveExpectationValueVariance -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveMatrixProductState.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveMatrixProductState.md index d8b33e6b512..ff45c0c06ee 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveMatrixProductState.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveMatrixProductState.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SaveMatrixProductState --- -# SaveMatrixProductState[¶](#savematrixproductstate "Permalink to this headline") +# SaveMatrixProductState -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilities.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilities.md index cf6ef9c5c3c..750f4dfb595 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilities.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilities.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SaveProbabilities --- -# SaveProbabilities[¶](#saveprobabilities "Permalink to this headline") +# SaveProbabilities -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilitiesDict.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilitiesDict.md index f1e9a6676dd..24aaefbd1fd 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilitiesDict.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveProbabilitiesDict.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SaveProbabilitiesDict --- -# SaveProbabilitiesDict[¶](#saveprobabilitiesdict "Permalink to this headline") +# SaveProbabilitiesDict -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveAverageData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveStabilizer.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveStabilizer.md index f33c0c50788..9e4d612450f 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveStabilizer.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveStabilizer.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SaveStabilizer --- -# SaveStabilizer[¶](#savestabilizer "Permalink to this headline") +# SaveStabilizer -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveState.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveState.md index 2f715d6919b..cb8857d14a2 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveState.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveState.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SaveState --- -# SaveState[¶](#savestate "Permalink to this headline") +# SaveState -`SaveState(num_qubits, label=None, pershot=False, conditional=False)` +`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_state.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevector.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevector.md index 48fe14a88cb..323c863b155 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevector.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevector.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SaveStatevector --- -# SaveStatevector[¶](#savestatevector "Permalink to this headline") +# SaveStatevector -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevectorDict.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevectorDict.md index 1f16316f277..aa18c03bbdf 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevectorDict.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveStatevectorDict.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SaveStatevectorDict --- -# SaveStatevectorDict[¶](#savestatevectordict "Permalink to this headline") +# SaveStatevectorDict -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveSuperOp.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveSuperOp.md index 2bc85d44167..d9ad2d95fc5 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveSuperOp.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveSuperOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SaveSuperOp --- -# SaveSuperOp[¶](#savesuperop "Permalink to this headline") +# SaveSuperOp -`SaveSuperOp(num_qubits, label='superop', pershot=False)` +`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_superop.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SaveUnitary.md b/docs/api/qiskit/0.41/qiskit_aer.library.SaveUnitary.md index b9f4b1c1772..da93367d185 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SaveUnitary.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SaveUnitary.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SaveUnitary --- -# SaveUnitary[¶](#saveunitary "Permalink to this headline") +# SaveUnitary -`SaveUnitary(num_qubits, label='unitary', pershot=False)` +`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_unitary.py "view source code") Bases: `qiskit_aer.library.save_instructions.save_data.SaveSingleData` diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SetDensityMatrix.md b/docs/api/qiskit/0.41/qiskit_aer.library.SetDensityMatrix.md index 53e65880641..f3fc262661e 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SetDensityMatrix.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SetDensityMatrix.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SetDensityMatrix --- -# SetDensityMatrix[¶](#setdensitymatrix "Permalink to this headline") +# SetDensityMatrix -`SetDensityMatrix(state)` +`SetDensityMatrix(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SetMatrixProductState.md b/docs/api/qiskit/0.41/qiskit_aer.library.SetMatrixProductState.md index f73ffbd04c2..095d26f3275 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SetMatrixProductState.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SetMatrixProductState.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SetMatrixProductState --- -# SetMatrixProductState[¶](#setmatrixproductstate "Permalink to this headline") +# SetMatrixProductState -`SetMatrixProductState(state)` +`SetMatrixProductState(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SetStabilizer.md b/docs/api/qiskit/0.41/qiskit_aer.library.SetStabilizer.md index 822a81fd4fe..26b4d86aeea 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SetStabilizer.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SetStabilizer.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SetStabilizer --- -# SetStabilizer[¶](#setstabilizer "Permalink to this headline") +# SetStabilizer -`SetStabilizer(state)` +`SetStabilizer(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SetStatevector.md b/docs/api/qiskit/0.41/qiskit_aer.library.SetStatevector.md index 29e9d2aa5fa..b79415d8eb7 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SetStatevector.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SetStatevector.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SetStatevector --- -# SetStatevector[¶](#setstatevector "Permalink to this headline") +# SetStatevector -`SetStatevector(state)` +`SetStatevector(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_statevector.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SetSuperOp.md b/docs/api/qiskit/0.41/qiskit_aer.library.SetSuperOp.md index a3406930ba0..a1818ec75a6 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SetSuperOp.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SetSuperOp.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SetSuperOp --- -# SetSuperOp[¶](#setsuperop "Permalink to this headline") +# SetSuperOp -`SetSuperOp(state)` +`SetSuperOp(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_superop.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.SetUnitary.md b/docs/api/qiskit/0.41/qiskit_aer.library.SetUnitary.md index 3eb005e9a34..590a0694967 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.SetUnitary.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.SetUnitary.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.library.SetUnitary --- -# SetUnitary[¶](#setunitary "Permalink to this headline") +# SetUnitary -`SetUnitary(state)` +`SetUnitary(state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_unitary.py "view source code") Bases: [`qiskit.circuit.instruction.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.instruction.Instruction") diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_amplitudes.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_amplitudes.md index 774a36c3eb0..390115a92e8 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_amplitudes.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_amplitudes.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.save_amplitudes --- -# qiskit\_aer.library.save\_amplitudes[¶](#qiskit-aer-library-save-amplitudes "Permalink to this headline") +# qiskit\_aer.library.save\_amplitudes -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_amplitudes_squared.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_amplitudes_squared.md index ef6741f43f8..c6e631fd67a 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_amplitudes_squared.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_amplitudes_squared.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.save_amplitudes_squared --- -# qiskit\_aer.library.save\_amplitudes\_squared[¶](#qiskit-aer-library-save-amplitudes-squared "Permalink to this headline") +# qiskit\_aer.library.save\_amplitudes\_squared -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_clifford.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_clifford.md index 78510e2457f..a15ce90d970 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_clifford.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_clifford.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.save_clifford --- -# qiskit\_aer.library.save\_clifford[¶](#qiskit-aer-library-save-clifford "Permalink to this headline") +# qiskit\_aer.library.save\_clifford -`save_clifford(self, label='clifford', pershot=False)` +`save_clifford(self, label='clifford', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_clifford.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_density_matrix.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_density_matrix.md index d308b26857b..c5bf046d92e 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_density_matrix.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_density_matrix.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.save_density_matrix --- -# qiskit\_aer.library.save\_density\_matrix[¶](#qiskit-aer-library-save-density-matrix "Permalink to this headline") +# qiskit\_aer.library.save\_density\_matrix -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_expectation_value.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_expectation_value.md index 3e7d3792bd9..83f3756753a 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_expectation_value.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_expectation_value.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.save_expectation_value --- -# qiskit\_aer.library.save\_expectation\_value[¶](#qiskit-aer-library-save-expectation-value "Permalink to this headline") +# qiskit\_aer.library.save\_expectation\_value -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_expectation_value_variance.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_expectation_value_variance.md index 1fd0ddbe01a..e0c48040e8b 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_expectation_value_variance.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_expectation_value_variance.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.save_expectation_value_variance --- -# qiskit\_aer.library.save\_expectation\_value\_variance[¶](#qiskit-aer-library-save-expectation-value-variance "Permalink to this headline") +# qiskit\_aer.library.save\_expectation\_value\_variance -`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` +`save_expectation_value_variance(self, operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_matrix_product_state.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_matrix_product_state.md index 4798aef3e3d..fc4efa9230c 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_matrix_product_state.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_matrix_product_state.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.save_matrix_product_state --- -# qiskit\_aer.library.save\_matrix\_product\_state[¶](#qiskit-aer-library-save-matrix-product-state "Permalink to this headline") +# qiskit\_aer.library.save\_matrix\_product\_state -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_matrix_product_state.py "view source code") Save the current simulator quantum state as a matrix product state. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_probabilities.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_probabilities.md index 44587c85410..3f917fa6387 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_probabilities.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_probabilities.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.save_probabilities --- -# qiskit\_aer.library.save\_probabilities[¶](#qiskit-aer-library-save-probabilities "Permalink to this headline") +# qiskit\_aer.library.save\_probabilities -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_probabilities_dict.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_probabilities_dict.md index 240e8399a88..d554184bcd8 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_probabilities_dict.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_probabilities_dict.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.save_probabilities_dict --- -# qiskit\_aer.library.save\_probabilities\_dict[¶](#qiskit-aer-library-save-probabilities-dict "Permalink to this headline") +# qiskit\_aer.library.save\_probabilities\_dict -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_stabilizer.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_stabilizer.md index 7206d56bec8..012a26267e4 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_stabilizer.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_stabilizer.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.save_stabilizer --- -# qiskit\_aer.library.save\_stabilizer[¶](#qiskit-aer-library-save-stabilizer "Permalink to this headline") +# qiskit\_aer.library.save\_stabilizer -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a StabilizerState. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_state.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_state.md index 355fa3718f9..b58f26be497 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_state.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_state.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.save_state --- -# qiskit\_aer.library.save\_state[¶](#qiskit-aer-library-save-state "Permalink to this headline") +# qiskit\_aer.library.save\_state -`save_state(self, label=None, pershot=False, conditional=False)` +`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_statevector.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_statevector.md index ae05237071d..f6638818b12 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_statevector.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_statevector.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.save_statevector --- -# qiskit\_aer.library.save\_statevector[¶](#qiskit-aer-library-save-statevector "Permalink to this headline") +# qiskit\_aer.library.save\_statevector -`save_statevector(self, label='statevector', pershot=False, conditional=False)` +`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_statevector_dict.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_statevector_dict.md index 57a2fd430d1..9b4deb5fb70 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_statevector_dict.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_statevector_dict.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.save_statevector_dict --- -# qiskit\_aer.library.save\_statevector\_dict[¶](#qiskit-aer-library-save-statevector-dict "Permalink to this headline") +# qiskit\_aer.library.save\_statevector\_dict -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector as a dict. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_superop.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_superop.md index 29a2c9c6996..4bed5d00e43 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_superop.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_superop.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.save_superop --- -# qiskit\_aer.library.save\_superop[¶](#qiskit-aer-library-save-superop "Permalink to this headline") +# qiskit\_aer.library.save\_superop -`save_superop(self, label='superop', pershot=False)` +`save_superop(self, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_superop.py "view source code") Save the current state of the superop simulator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.save_unitary.md b/docs/api/qiskit/0.41/qiskit_aer.library.save_unitary.md index a398db77fb8..fd8a0373bab 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.save_unitary.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.save_unitary.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.save_unitary --- -# qiskit\_aer.library.save\_unitary[¶](#qiskit-aer-library-save-unitary "Permalink to this headline") +# qiskit\_aer.library.save\_unitary -`save_unitary(self, label='unitary', pershot=False)` +`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.set_density_matrix.md b/docs/api/qiskit/0.41/qiskit_aer.library.set_density_matrix.md index 1e4e30b5e99..2938daa4809 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.set_density_matrix.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.set_density_matrix.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.set_density_matrix --- -# qiskit\_aer.library.set\_density\_matrix[¶](#qiskit-aer-library-set-density-matrix "Permalink to this headline") +# qiskit\_aer.library.set\_density\_matrix -`set_density_matrix(self, state)` +`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.set_matrix_product_state.md b/docs/api/qiskit/0.41/qiskit_aer.library.set_matrix_product_state.md index 72fab64aefa..a8c1135644e 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.set_matrix_product_state.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.set_matrix_product_state.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.set_matrix_product_state --- -# qiskit\_aer.library.set\_matrix\_product\_state[¶](#qiskit-aer-library-set-matrix-product-state "Permalink to this headline") +# qiskit\_aer.library.set\_matrix\_product\_state -`set_matrix_product_state(self, state)` +`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.set_stabilizer.md b/docs/api/qiskit/0.41/qiskit_aer.library.set_stabilizer.md index 8d529f839ed..690a1072521 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.set_stabilizer.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.set_stabilizer.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.set_stabilizer --- -# qiskit\_aer.library.set\_stabilizer[¶](#qiskit-aer-library-set-stabilizer "Permalink to this headline") +# qiskit\_aer.library.set\_stabilizer -`set_stabilizer(self, state)` +`set_stabilizer(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_stabilizer.py "view source code") Set the Clifford stabilizer state of the simulator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.set_statevector.md b/docs/api/qiskit/0.41/qiskit_aer.library.set_statevector.md index 5ef80d9c333..41e1bce3a7c 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.set_statevector.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.set_statevector.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.set_statevector --- -# qiskit\_aer.library.set\_statevector[¶](#qiskit-aer-library-set-statevector "Permalink to this headline") +# qiskit\_aer.library.set\_statevector -`set_statevector(self, state)` +`set_statevector(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_statevector.py "view source code") Set the statevector state of the simulator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.set_superop.md b/docs/api/qiskit/0.41/qiskit_aer.library.set_superop.md index c66b6512bc2..48988d8ec8c 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.set_superop.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.set_superop.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.set_superop --- -# qiskit\_aer.library.set\_superop[¶](#qiskit-aer-library-set-superop "Permalink to this headline") +# qiskit\_aer.library.set\_superop -`set_superop(self, state)` +`set_superop(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_superop.py "view source code") Set the superop state of the simulator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.library.set_unitary.md b/docs/api/qiskit/0.41/qiskit_aer.library.set_unitary.md index b1c9ec68921..e6f8fd9c84e 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.library.set_unitary.md +++ b/docs/api/qiskit/0.41/qiskit_aer.library.set_unitary.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.library.set_unitary --- -# qiskit\_aer.library.set\_unitary[¶](#qiskit-aer-library-set-unitary "Permalink to this headline") +# qiskit\_aer.library.set\_unitary -`set_unitary(self, state)` +`set_unitary(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/library/set_instructions/set_unitary.py "view source code") Set the state state of the simulator. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.LocalNoisePass.md b/docs/api/qiskit/0.41/qiskit_aer.noise.LocalNoisePass.md index 7cecb3c48fd..c1b8d94266e 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.LocalNoisePass.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.LocalNoisePass.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.noise.LocalNoisePass --- -# LocalNoisePass[¶](#localnoisepass "Permalink to this headline") +# LocalNoisePass -`LocalNoisePass(func, op_types=None, method='append')` +`LocalNoisePass(func, op_types=None, method='append')`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/local_noise_pass.py "view source code") Bases: [`qiskit.transpiler.basepasses.TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.basepasses.TransformationPass") @@ -63,7 +63,7 @@ Return the name of the pass. -`LocalNoisePass.run(dag)` +`LocalNoisePass.run(dag)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/local_noise_pass.py "view source code") Run the LocalNoisePass pass on dag. :type dag: [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.dagcircuit.DAGCircuit") :param dag: DAG to be changed. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.NoiseModel.md b/docs/api/qiskit/0.41/qiskit_aer.noise.NoiseModel.md index a804dfa5c5e..2952b33e4f2 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.NoiseModel.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.NoiseModel.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.noise.NoiseModel --- -# NoiseModel[¶](#noisemodel "Permalink to this headline") +# NoiseModel -`NoiseModel(basis_gates=None)` +`NoiseModel(basis_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Bases: `object` @@ -68,7 +68,7 @@ Additional Information: Errors added to the noise model will have their instruct -`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)` +`NoiseModel.add_all_qubit_quantum_error(error, instructions, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a quantum error to the noise model that applies to all qubits. @@ -90,7 +90,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_all_qubit_readout_error(error, warnings=True)` +`NoiseModel.add_all_qubit_readout_error(error, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a single-qubit readout error that applies measure on all qubits. @@ -111,7 +111,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_basis_gates(instructions, warnings=False)` +`NoiseModel.add_basis_gates(instructions, warnings=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add additional gates to the noise model basis\_gates. @@ -126,7 +126,7 @@ This should be used to add any gates that are identified by a custom gate label -`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)` +`NoiseModel.add_nonlocal_quantum_error(error, instructions, qubits, noise_qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a non-local quantum error to the noise model (DEPRECATED). @@ -154,7 +154,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)` +`NoiseModel.add_quantum_error(error, instructions, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a quantum error to the noise model. @@ -177,7 +177,7 @@ If the error object is ideal it will not be added to the model. -`NoiseModel.add_readout_error(error, qubits, warnings=True)` +`NoiseModel.add_readout_error(error, qubits, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Add a readout error to the noise model. @@ -199,7 +199,7 @@ If the error object is ideal it will not be added to the model. -`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=None, warnings=None)` +`classmethod NoiseModel.from_backend(backend, gate_error=True, readout_error=True, thermal_relaxation=True, temperature=0, gate_lengths=None, gate_length_units='ns', standard_gates=None, warnings=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Return a noise model derived from a devices backend properties. @@ -265,7 +265,7 @@ An approximate noise model for the device backend. -`static NoiseModel.from_dict(noise_dict)` +`static NoiseModel.from_dict(noise_dict)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Load NoiseModel from a dictionary. @@ -289,7 +289,7 @@ the noise model. -`NoiseModel.is_ideal()` +`NoiseModel.is_ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Return True if the noise model has no noise terms. @@ -297,7 +297,7 @@ Return True if the noise model has no noise terms. -`NoiseModel.reset()` +`NoiseModel.reset()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Reset the noise model. @@ -305,7 +305,7 @@ Reset the noise model. -`NoiseModel.to_dict(serializable=False)` +`NoiseModel.to_dict(serializable=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/noise_model.py "view source code") Return the noise model as a dictionary. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.QuantumError.md b/docs/api/qiskit/0.41/qiskit_aer.noise.QuantumError.md index 07ca0461080..c81f1308985 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.QuantumError.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.QuantumError.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.noise.QuantumError --- -# QuantumError[¶](#quantumerror "Permalink to this headline") +# QuantumError -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=None, atol=None)` +`QuantumError(noise_ops, number_of_qubits=None, standard_gates=None, atol=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Bases: `qiskit.quantum_info.operators.base_operator.BaseOperator`, `qiskit.quantum_info.operators.mixins.tolerances.TolerancesMixin` @@ -64,7 +64,7 @@ noise_ops = Kraus([np.sqrt(0.9) * np.array([[1, 0], [0, 1]]), -`QuantumError.compose(other, qargs=None, front=False)` +`QuantumError.compose(other, qargs=None, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the operator composition with another CLASS. @@ -96,7 +96,7 @@ CLASS -`QuantumError.copy()` +`QuantumError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Make a copy of current QuantumError. @@ -129,7 +129,7 @@ The right matrix multiplied Operator. -`QuantumError.error_term(position)` +`QuantumError.error_term(position)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return a single term from the error. @@ -154,7 +154,7 @@ tuple -`QuantumError.expand(other)` +`QuantumError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the reverse-order tensor product with another CLASS. @@ -176,7 +176,7 @@ CLASS -`QuantumError.ideal()` +`QuantumError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return True if this error object is composed only of identity operations. Note that the identity check is best effort and up to global phase. @@ -250,7 +250,7 @@ BaseOperator -`classmethod QuantumError.set_atol(value)` +`classmethod QuantumError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -258,7 +258,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod QuantumError.set_rtol(value)` +`classmethod QuantumError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -266,7 +266,7 @@ Set the class default relative tolerance parameter for float comparisons. -`QuantumError.tensor(other)` +`QuantumError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the tensor product with another CLASS. @@ -292,7 +292,7 @@ CLASS -`QuantumError.to_dict()` +`QuantumError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Return the current error as a dictionary. @@ -300,7 +300,7 @@ Return the current error as a dictionary. -`QuantumError.to_instruction()` +`QuantumError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a circuit Instruction. @@ -308,7 +308,7 @@ Convert the QuantumError to a circuit Instruction. -`QuantumError.to_quantumchannel()` +`QuantumError.to_quantumchannel()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/quantum_error.py "view source code") Convert the QuantumError to a SuperOp quantum channel. Required to enable SuperOp(QuantumError). diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.ReadoutError.md b/docs/api/qiskit/0.41/qiskit_aer.noise.ReadoutError.md index 83a3843c3ad..473f00da065 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.ReadoutError.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.ReadoutError.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.noise.ReadoutError --- -# ReadoutError[¶](#readouterror "Permalink to this headline") +# ReadoutError -`ReadoutError(probabilities, atol=1e-08)` +`ReadoutError(probabilities, atol=1e-08)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Bases: `object` @@ -57,7 +57,7 @@ probabilities[3] = [P("00"|"11"), P("01"|"11"), P("10"|"11"), P("11"|"11")] -`ReadoutError.compose(other, front=False)` +`ReadoutError.compose(other, front=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the composition readout error other \* self. @@ -85,7 +85,7 @@ The composition readout error. -`ReadoutError.copy()` +`ReadoutError.copy()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Make a copy of current ReadoutError. @@ -93,7 +93,7 @@ Make a copy of current ReadoutError. -`ReadoutError.dot(other)` +`ReadoutError.dot(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the composition readout error self \* other. @@ -118,7 +118,7 @@ The composition readout error. -`ReadoutError.expand(other)` +`ReadoutError.expand(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -142,7 +142,7 @@ the tensor product readout error other ⊗ self. -`ReadoutError.ideal()` +`ReadoutError.ideal()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return True if current error object is an identity @@ -150,7 +150,7 @@ Return True if current error object is an identity -`ReadoutError.power(n)` +`ReadoutError.power(n)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the compose of the readout error with itself n times. @@ -174,7 +174,7 @@ the n-times composition channel. -`classmethod ReadoutError.set_atol(value)` +`classmethod ReadoutError.set_atol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Set the class default absolute tolerance parameter for float comparisons. @@ -182,7 +182,7 @@ Set the class default absolute tolerance parameter for float comparisons. -`classmethod ReadoutError.set_rtol(value)` +`classmethod ReadoutError.set_rtol(value)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Set the class default relative tolerance parameter for float comparisons. @@ -190,7 +190,7 @@ Set the class default relative tolerance parameter for float comparisons. -`ReadoutError.tensor(other)` +`ReadoutError.tensor(other)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the tensor product readout error self ⊗ other. @@ -214,7 +214,7 @@ the tensor product readout error self ⊗ other. -`ReadoutError.to_dict()` +`ReadoutError.to_dict()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Return the current error as a dictionary. @@ -222,7 +222,7 @@ Return the current error as a dictionary. -`ReadoutError.to_instruction()` +`ReadoutError.to_instruction()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/readout_error.py "view source code") Convert the ReadoutError to a circuit Instruction. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.RelaxationNoisePass.md b/docs/api/qiskit/0.41/qiskit_aer.noise.RelaxationNoisePass.md index 1a457ad15a5..cf2c6e6cba9 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.RelaxationNoisePass.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.RelaxationNoisePass.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.noise.RelaxationNoisePass --- -# RelaxationNoisePass[¶](#relaxationnoisepass "Permalink to this headline") +# RelaxationNoisePass -`RelaxationNoisePass(t1s, t2s, dt=None, op_types=None, excited_state_populations=None)` +`RelaxationNoisePass(t1s, t2s, dt=None, op_types=None, excited_state_populations=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/passes/relaxation_noise_pass.py "view source code") Bases: [`qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass`](qiskit_aer.noise.LocalNoisePass "qiskit_aer.noise.passes.local_noise_pass.LocalNoisePass") diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.amplitude_damping_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.amplitude_damping_error.md index d2b3fb259f6..060dec129a3 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.amplitude_damping_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.amplitude_damping_error.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.noise.amplitude_damping_error --- -# qiskit\_aer.noise.amplitude\_damping\_error[¶](#qiskit-aer-noise-amplitude-damping-error "Permalink to this headline") +# qiskit\_aer.noise.amplitude\_damping\_error -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.coherent_unitary_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.coherent_unitary_error.md index c214962ce59..f90a1a068c5 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.coherent_unitary_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.coherent_unitary_error.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.noise.coherent_unitary_error --- -# qiskit\_aer.noise.coherent\_unitary\_error[¶](#qiskit-aer-noise-coherent-unitary-error "Permalink to this headline") +# qiskit\_aer.noise.coherent\_unitary\_error -`coherent_unitary_error(unitary)` +`coherent_unitary_error(unitary)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a coherent unitary quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.depolarizing_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.depolarizing_error.md index 3e05c3fde1e..682b4c35050 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.depolarizing_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.depolarizing_error.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.noise.depolarizing_error --- -# qiskit\_aer.noise.depolarizing\_error[¶](#qiskit-aer-noise-depolarizing-error "Permalink to this headline") +# qiskit\_aer.noise.depolarizing\_error -`depolarizing_error(param, num_qubits, standard_gates=None)` +`depolarizing_error(param, num_qubits, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a depolarizing quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.device.basic_device_gate_errors.md b/docs/api/qiskit/0.41/qiskit_aer.noise.device.basic_device_gate_errors.md index cd4b717d49d..bbb6ff34ecf 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.device.basic_device_gate_errors.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.device.basic_device_gate_errors.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.noise.device.basic_device_gate_errors --- -# qiskit\_aer.noise.device.basic\_device\_gate\_errors[¶](#qiskit-aer-noise-device-basic-device-gate-errors "Permalink to this headline") +# qiskit\_aer.noise.device.basic\_device\_gate\_errors -`basic_device_gate_errors(properties=None, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=None, warnings=None, target=None)` +`basic_device_gate_errors(properties=None, gate_error=True, thermal_relaxation=True, gate_lengths=None, gate_length_units='ns', temperature=0, standard_gates=None, warnings=None, target=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/models.py "view source code") Return QuantumErrors derived from either of a devices BackendProperties or Target. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.device.basic_device_readout_errors.md b/docs/api/qiskit/0.41/qiskit_aer.noise.device.basic_device_readout_errors.md index eb1fcc410a7..036856d7afc 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.device.basic_device_readout_errors.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.device.basic_device_readout_errors.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.noise.device.basic_device_readout_errors --- -# qiskit\_aer.noise.device.basic\_device\_readout\_errors[¶](#qiskit-aer-noise-device-basic-device-readout-errors "Permalink to this headline") +# qiskit\_aer.noise.device.basic\_device\_readout\_errors -`basic_device_readout_errors(properties=None, target=None)` +`basic_device_readout_errors(properties=None, target=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/models.py "view source code") Return readout error parameters from either of device Target or BackendProperties. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_error_values.md b/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_error_values.md index 79c1ad9bf6d..995c5adf824 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_error_values.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_error_values.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.noise.device.gate_error_values --- -# qiskit\_aer.noise.device.gate\_error\_values[¶](#qiskit-aer-noise-device-gate-error-values "Permalink to this headline") +# qiskit\_aer.noise.device.gate\_error\_values -`gate_error_values(properties)` +`gate_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return gate error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_length_values.md b/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_length_values.md index 7f224e1e04c..c7985d8a231 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_length_values.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_length_values.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.noise.device.gate_length_values --- -# qiskit\_aer.noise.device.gate\_length\_values[¶](#qiskit-aer-noise-device-gate-length-values "Permalink to this headline") +# qiskit\_aer.noise.device.gate\_length\_values -`gate_length_values(properties)` +`gate_length_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return gate length values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_param_values.md b/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_param_values.md index c9e5812da82..9a03c869835 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_param_values.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.device.gate_param_values.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.noise.device.gate_param_values --- -# qiskit\_aer.noise.device.gate\_param\_values[¶](#qiskit-aer-noise-device-gate-param-values "Permalink to this headline") +# qiskit\_aer.noise.device.gate\_param\_values -`gate_param_values(properties)` +`gate_param_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return parameter error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.device.readout_error_values.md b/docs/api/qiskit/0.41/qiskit_aer.noise.device.readout_error_values.md index 53b79b9f790..9e7cd14a25f 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.device.readout_error_values.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.device.readout_error_values.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.noise.device.readout_error_values --- -# qiskit\_aer.noise.device.readout\_error\_values[¶](#qiskit-aer-noise-device-readout-error-values "Permalink to this headline") +# qiskit\_aer.noise.device.readout\_error\_values -`readout_error_values(properties)` +`readout_error_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return readout error values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.device.thermal_relaxation_values.md b/docs/api/qiskit/0.41/qiskit_aer.noise.device.thermal_relaxation_values.md index 2d4cbc8984e..4315386aea1 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.device.thermal_relaxation_values.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.device.thermal_relaxation_values.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.noise.device.thermal_relaxation_values --- -# qiskit\_aer.noise.device.thermal\_relaxation\_values[¶](#qiskit-aer-noise-device-thermal-relaxation-values "Permalink to this headline") +# qiskit\_aer.noise.device.thermal\_relaxation\_values -`thermal_relaxation_values(properties)` +`thermal_relaxation_values(properties)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/device/parameters.py "view source code") Return T1, T2 and frequency values from a devices BackendProperties. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.kraus_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.kraus_error.md index f03c5ddfcdf..1d5fb16a3df 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.kraus_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.kraus_error.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.noise.kraus_error --- -# qiskit\_aer.noise.kraus\_error[¶](#qiskit-aer-noise-kraus-error "Permalink to this headline") +# qiskit\_aer.noise.kraus\_error -`kraus_error(noise_ops, standard_gates=None, canonical_kraus=False)` +`kraus_error(noise_ops, standard_gates=None, canonical_kraus=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a Kraus quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.mixed_unitary_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.mixed_unitary_error.md index f77a0680040..134d564711e 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.mixed_unitary_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.mixed_unitary_error.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.noise.mixed_unitary_error --- -# qiskit\_aer.noise.mixed\_unitary\_error[¶](#qiskit-aer-noise-mixed-unitary-error "Permalink to this headline") +# qiskit\_aer.noise.mixed\_unitary\_error -`mixed_unitary_error(noise_ops, standard_gates=None)` +`mixed_unitary_error(noise_ops, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a mixed unitary quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.pauli_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.pauli_error.md index c6412801078..b4e9f01faec 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.pauli_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.pauli_error.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.noise.pauli_error --- -# qiskit\_aer.noise.pauli\_error[¶](#qiskit-aer-noise-pauli-error "Permalink to this headline") +# qiskit\_aer.noise.pauli\_error -`pauli_error(noise_ops, standard_gates=None)` +`pauli_error(noise_ops, standard_gates=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a mixed Pauli quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.phase_amplitude_damping_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.phase_amplitude_damping_error.md index a2f92c21ce1..70ced555d78 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.phase_amplitude_damping_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.phase_amplitude_damping_error.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.noise.phase_amplitude_damping_error --- -# qiskit\_aer.noise.phase\_amplitude\_damping\_error[¶](#qiskit-aer-noise-phase-amplitude-damping-error "Permalink to this headline") +# qiskit\_aer.noise.phase\_amplitude\_damping\_error -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.phase_damping_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.phase_damping_error.md index fbff6f9c471..2dadfc13527 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.phase_damping_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.phase_damping_error.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.noise.phase_damping_error --- -# qiskit\_aer.noise.phase\_damping\_error[¶](#qiskit-aer-noise-phase-damping-error "Permalink to this headline") +# qiskit\_aer.noise.phase\_damping\_error -`phase_damping_error(param_phase, canonical_kraus=True)` +`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized phase damping quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.reset_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.reset_error.md index 426880bfe48..955de63ad01 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.reset_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.reset_error.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.noise.reset_error --- -# qiskit\_aer.noise.reset\_error[¶](#qiskit-aer-noise-reset-error "Permalink to this headline") +# qiskit\_aer.noise.reset\_error -`reset_error(prob0, prob1=0)` +`reset_error(prob0, prob1=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single qubit reset quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.noise.thermal_relaxation_error.md b/docs/api/qiskit/0.41/qiskit_aer.noise.thermal_relaxation_error.md index d65e91f61be..52d4dc7edcd 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.noise.thermal_relaxation_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.noise.thermal_relaxation_error.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.noise.thermal_relaxation_error --- -# qiskit\_aer.noise.thermal\_relaxation\_error[¶](#qiskit-aer-noise-thermal-relaxation-error "Permalink to this headline") +# qiskit\_aer.noise.thermal\_relaxation\_error -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. diff --git a/docs/api/qiskit/0.41/qiskit_aer.primitives.Estimator.md b/docs/api/qiskit/0.41/qiskit_aer.primitives.Estimator.md index fdfcf02f19c..e997121e9b8 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.primitives.Estimator.md +++ b/docs/api/qiskit/0.41/qiskit_aer.primitives.Estimator.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.primitives.Estimator --- -# Estimator[¶](#estimator "Permalink to this headline") +# Estimator -`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` +`Estimator(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, observables: Iterable[SparsePauliOp] | SparsePauliOp | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/estimator.py "view source code") Bases: [`qiskit.primitives.base.base_estimator.BaseEstimator`](qiskit.primitives.BaseEstimator "qiskit.primitives.base.base_estimator.BaseEstimator") @@ -49,7 +49,7 @@ Aer implmentation of Estimator. -`Estimator.close()` +`Estimator.close()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/estimator.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.41/qiskit_aer.primitives.Sampler.md b/docs/api/qiskit/0.41/qiskit_aer.primitives.Sampler.md index fa4b3da8862..1a3544818de 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.primitives.Sampler.md +++ b/docs/api/qiskit/0.41/qiskit_aer.primitives.Sampler.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.primitives.Sampler --- -# Sampler[¶](#sampler "Permalink to this headline") +# Sampler -`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)` +`Sampler(circuits: Iterable[QuantumCircuit] | QuantumCircuit | None = None, parameters: Iterable[Iterable[Parameter]] | None = None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py "view source code") Bases: [`qiskit.primitives.base.base_sampler.BaseSampler`](qiskit.primitives.BaseSampler "qiskit.primitives.base.base_sampler.BaseSampler") @@ -45,7 +45,7 @@ Aer implementation of Sampler class. -`Sampler.close()` +`Sampler.close()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/primitives/sampler.py "view source code") Close the session and free resources diff --git a/docs/api/qiskit/0.41/qiskit_aer.pulse.PulseSystemModel.md b/docs/api/qiskit/0.41/qiskit_aer.pulse.PulseSystemModel.md index 77a4be8f2cc..1f9c2bb1d0c 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.pulse.PulseSystemModel.md +++ b/docs/api/qiskit/0.41/qiskit_aer.pulse.PulseSystemModel.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.pulse.PulseSystemModel --- -# PulseSystemModel[¶](#pulsesystemmodel "Permalink to this headline") +# PulseSystemModel -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Bases: `object` @@ -50,7 +50,7 @@ Initialize a PulseSystemModel. -`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)` +`PulseSystemModel.calculate_channel_frequencies(qubit_lo_freq=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Calculate frequencies for each channel given qubit\_lo\_freq. @@ -74,7 +74,7 @@ OrderedDict -`PulseSystemModel.control_channel_index(label)` +`PulseSystemModel.control_channel_index(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Return the index of the control channel with identifying label. @@ -94,7 +94,7 @@ int or None -`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)` +`classmethod PulseSystemModel.from_backend(backend, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. @@ -119,7 +119,7 @@ the PulseSystemModel constructed from the backend. -`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)` +`classmethod PulseSystemModel.from_config(configuration, subsystem_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/pulse_system_model.py "view source code") Construct a model from configuration and defaults. diff --git a/docs/api/qiskit/0.41/qiskit_aer.pulse.duffing_system_model.md b/docs/api/qiskit/0.41/qiskit_aer.pulse.duffing_system_model.md index 9542721fc35..ea9d60c65fd 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.pulse.duffing_system_model.md +++ b/docs/api/qiskit/0.41/qiskit_aer.pulse.duffing_system_model.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.pulse.duffing_system_model --- -# qiskit\_aer.pulse.duffing\_system\_model[¶](#qiskit-aer-pulse-duffing-system-model "Permalink to this headline") +# qiskit\_aer.pulse.duffing\_system\_model -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/pulse/system_models/duffing_model_generators.py "view source code") Returns a [`PulseSystemModel`](qiskit_aer.pulse.PulseSystemModel "qiskit_aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. diff --git a/docs/api/qiskit/0.41/qiskit_aer.quantum_info.AerStatevector.md b/docs/api/qiskit/0.41/qiskit_aer.quantum_info.AerStatevector.md index 61b18f38005..e493338ab54 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.quantum_info.AerStatevector.md +++ b/docs/api/qiskit/0.41/qiskit_aer.quantum_info.AerStatevector.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.quantum_info.AerStatevector --- -# AerStatevector[¶](#aerstatevector "Permalink to this headline") +# AerStatevector -`AerStatevector(data, dims=None, **configs)` +`AerStatevector(data, dims=None, **configs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Bases: [`qiskit.quantum_info.states.statevector.Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.states.statevector.Statevector") @@ -38,7 +38,7 @@ The `dims` kwarg is used to `Statevector` constructor. -`AerStatevector.conjugate()` +`AerStatevector.conjugate()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return the conjugate of the operator. @@ -210,7 +210,7 @@ complex -`classmethod AerStatevector.from_instruction(instruction)` +`classmethod AerStatevector.from_instruction(instruction)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return the output statevector of an instruction. @@ -236,7 +236,7 @@ The final statevector. -`static AerStatevector.from_int(i, dims)` +`static AerStatevector.from_int(i, dims)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return a computational basis statevector. @@ -264,7 +264,7 @@ The `dims` kwarg can be an integer or an iterable of integers. -`classmethod AerStatevector.from_label(label)` +`classmethod AerStatevector.from_label(label)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return a tensor product of Pauli X,Y,Z eigenstates. @@ -353,7 +353,7 @@ tuple -`AerStatevector.metadata()` +`AerStatevector.metadata()`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Return result metadata of an operation that executed lastly. @@ -536,7 +536,7 @@ Additional Information: -`AerStatevector.sample_memory(shots, qargs=None)` +`AerStatevector.sample_memory(shots, qargs=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Sample a list of qubit measurement outcomes in the computational basis. @@ -563,7 +563,7 @@ Additional Information: -`AerStatevector.seed(value=None)` +`AerStatevector.seed(value=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/quantum_info/states/aer_statevector.py "view source code") Set the seed for the quantum state RNG. diff --git a/docs/api/qiskit/0.41/qiskit_aer.utils.NoiseTransformer.md b/docs/api/qiskit/0.41/qiskit_aer.utils.NoiseTransformer.md index 27087bf8110..19ae0afd358 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.utils.NoiseTransformer.md +++ b/docs/api/qiskit/0.41/qiskit_aer.utils.NoiseTransformer.md @@ -6,11 +6,11 @@ python_api_type: class python_api_name: qiskit_aer.utils.NoiseTransformer --- -# NoiseTransformer[¶](#noisetransformer "Permalink to this headline") +# NoiseTransformer -`NoiseTransformer` +`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Bases: `object` @@ -22,7 +22,7 @@ Bases: `object` -`NoiseTransformer.channel_matrix_representation(operators)` +`NoiseTransformer.channel_matrix_representation(operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") We convert the operators to a matrix by applying the channel to the four basis elements of the 2x2 matrix space representing density operators; this is standard linear algebra @@ -42,7 +42,7 @@ sympy.Matrix -`NoiseTransformer.compute_P(As)` +`NoiseTransformer.compute_P(As)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") This method creates the matrix P in the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the channel matrices :type As: list @@ -58,7 +58,7 @@ matrix -`static NoiseTransformer.compute_channel_operation(rho, operators)` +`static NoiseTransformer.compute_channel_operation(rho, operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Given a quantum state’s density function rho, the effect of the channel on this state is: rho -> sum\_\{i=1}^n E\_i \* rho \* E\_i^dagger @@ -79,7 +79,7 @@ number -`NoiseTransformer.compute_q(As, C)` +`NoiseTransformer.compute_q(As, C)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") This method creates the vector q for the f(x) = 1/2(x\*P\*x)+q\*x representation of the objective function :param As: list of symbolic matrices repersenting the quadratic program :type As: list :param C: matrix representing the the constant channel matrix :type C: matrix @@ -95,7 +95,7 @@ list -`static NoiseTransformer.fidelity(channel)` +`static NoiseTransformer.fidelity(channel)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Calculates channel fidelity @@ -103,7 +103,7 @@ Calculates channel fidelity -`static NoiseTransformer.flatten_matrix(m)` +`static NoiseTransformer.flatten_matrix(m)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") **Parameters** @@ -121,7 +121,7 @@ list -`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)` +`NoiseTransformer.generate_channel_matrices(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Generate symbolic channel matrices. @@ -163,7 +163,7 @@ list -`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)` +`NoiseTransformer.generate_channel_quadratic_programming_matrices(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Generate matrices for quadratic program. @@ -184,7 +184,7 @@ list -`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)` +`static NoiseTransformer.get_const_matrix_from_channel(channel, symbols)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Extract the numeric constant matrix. @@ -209,7 +209,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`static NoiseTransformer.get_matrix_from_channel(channel, symbol)` +`static NoiseTransformer.get_matrix_from_channel(channel, symbol)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Extract the numeric parameter matrix. @@ -234,7 +234,7 @@ Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomia -`NoiseTransformer.operator_circuit(operator)` +`NoiseTransformer.operator_circuit(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Converts an operator representation to noise circuit. @@ -254,7 +254,7 @@ List -`NoiseTransformer.operator_matrix(operator)` +`NoiseTransformer.operator_matrix(operator)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Converts an operator representation to Kraus matrix representation @@ -274,7 +274,7 @@ the operator, converted to Kraus representation. -`static NoiseTransformer.prepare_channel_operator_list(ops_list)` +`static NoiseTransformer.prepare_channel_operator_list(ops_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Prepares a list of channel operators. @@ -294,7 +294,7 @@ List -`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)` +`NoiseTransformer.prepare_honesty_constraint(transform_channel_operators_list)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Prepares the honesty constraint. @@ -307,7 +307,7 @@ Prepares the honesty constraint. -`NoiseTransformer.solve_quadratic_program(P, q)` +`NoiseTransformer.solve_quadratic_program(P, q)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Solve the quadratic program optimization problem. @@ -331,7 +331,7 @@ This method is the only place in the code where we rely on the cvxpy library sho -`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)` +`NoiseTransformer.transform_by_given_channel(channel_matrices, const_channel_matrix)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Transform by by quantum channels. @@ -356,7 +356,7 @@ list -`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)` +`NoiseTransformer.transform_by_operator_list(transform_channel_operators, noise_kraus_operators)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Transform input Kraus operators. diff --git a/docs/api/qiskit/0.41/qiskit_aer.utils.approximate_noise_model.md b/docs/api/qiskit/0.41/qiskit_aer.utils.approximate_noise_model.md index 72f306fa1f1..fb3f3841a0a 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.utils.approximate_noise_model.md +++ b/docs/api/qiskit/0.41/qiskit_aer.utils.approximate_noise_model.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.utils.approximate_noise_model --- -# qiskit\_aer.utils.approximate\_noise\_model[¶](#qiskit-aer-utils-approximate-noise-model "Permalink to this headline") +# qiskit\_aer.utils.approximate\_noise\_model -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Replace all noises in a noise model with ones approximated by a mixture of operators (channels). diff --git a/docs/api/qiskit/0.41/qiskit_aer.utils.approximate_quantum_error.md b/docs/api/qiskit/0.41/qiskit_aer.utils.approximate_quantum_error.md index 45e1b0306cd..b11ed875e94 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.utils.approximate_quantum_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.utils.approximate_quantum_error.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.utils.approximate_quantum_error --- -# qiskit\_aer.utils.approximate\_quantum\_error[¶](#qiskit-aer-utils-approximate-quantum-error "Permalink to this headline") +# qiskit\_aer.utils.approximate\_quantum\_error -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a `QuantumError` object that approximates an error as a mixture of specified operators (channels). diff --git a/docs/api/qiskit/0.41/qiskit_aer.utils.insert_noise.md b/docs/api/qiskit/0.41/qiskit_aer.utils.insert_noise.md index 97c2ff17da1..4a76436e647 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.utils.insert_noise.md +++ b/docs/api/qiskit/0.41/qiskit_aer.utils.insert_noise.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.utils.insert_noise --- -# qiskit\_aer.utils.insert\_noise[¶](#qiskit-aer-utils-insert-noise "Permalink to this headline") +# qiskit\_aer.utils.insert\_noise -`insert_noise(circuits, noise_model, transpile=False)` +`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. diff --git a/docs/api/qiskit/0.41/qiskit_aer.utils.remap_noise_model.md b/docs/api/qiskit/0.41/qiskit_aer.utils.remap_noise_model.md index bf5fa1c7bc3..c299cda8af2 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.utils.remap_noise_model.md +++ b/docs/api/qiskit/0.41/qiskit_aer.utils.remap_noise_model.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.utils.remap_noise_model --- -# qiskit\_aer.utils.remap\_noise\_model[¶](#qiskit-aer-utils-remap-noise-model "Permalink to this headline") +# qiskit\_aer.utils.remap\_noise\_model -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_remapper.py "view source code") \[Deprecated] Remap qubits in a noise model. diff --git a/docs/api/qiskit/0.41/qiskit_aer.utils.transform_noise_model.md b/docs/api/qiskit/0.41/qiskit_aer.utils.transform_noise_model.md index 8f1ba38e7ce..d7301f5f544 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.utils.transform_noise_model.md +++ b/docs/api/qiskit/0.41/qiskit_aer.utils.transform_noise_model.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.utils.transform_noise_model --- -# qiskit\_aer.utils.transform\_noise\_model[¶](#qiskit-aer-utils-transform-noise-model "Permalink to this headline") +# qiskit\_aer.utils.transform\_noise\_model -`transform_noise_model(noise_model, func)` +`transform_noise_model(noise_model, func)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a new noise model by applyign a function to all quantum errors. diff --git a/docs/api/qiskit/0.41/qiskit_aer.utils.transpile_noise_model.md b/docs/api/qiskit/0.41/qiskit_aer.utils.transpile_noise_model.md index 5b295068f04..4fd8ade1fe4 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.utils.transpile_noise_model.md +++ b/docs/api/qiskit/0.41/qiskit_aer.utils.transpile_noise_model.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.utils.transpile_noise_model --- -# qiskit\_aer.utils.transpile\_noise\_model[¶](#qiskit-aer-utils-transpile-noise-model "Permalink to this headline") +# qiskit\_aer.utils.transpile\_noise\_model -`transpile_noise_model(noise_model, **transpile_kwargs)` +`transpile_noise_model(noise_model, **transpile_kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a new noise model with transpiled QuantumErrors. diff --git a/docs/api/qiskit/0.41/qiskit_aer.utils.transpile_quantum_error.md b/docs/api/qiskit/0.41/qiskit_aer.utils.transpile_quantum_error.md index 53f7a2d92c9..0e89f33a58f 100644 --- a/docs/api/qiskit/0.41/qiskit_aer.utils.transpile_quantum_error.md +++ b/docs/api/qiskit/0.41/qiskit_aer.utils.transpile_quantum_error.md @@ -6,11 +6,11 @@ python_api_type: function python_api_name: qiskit_aer.utils.transpile_quantum_error --- -# qiskit\_aer.utils.transpile\_quantum\_error[¶](#qiskit-aer-utils-transpile-quantum-error "Permalink to this headline") +# qiskit\_aer.utils.transpile\_quantum\_error -`transpile_quantum_error(error, **transpile_kwargs)` +`transpile_quantum_error(error, **transpile_kwargs)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.11/qiskit_aer/utils/noise_transformation.py "view source code") Return a new quantum error containin transpiled circuits. diff --git a/docs/api/qiskit/0.41/qobj.md b/docs/api/qiskit/0.41/qobj.md index 9c9bfa55c33..81f575f0166 100644 --- a/docs/api/qiskit/0.41/qobj.md +++ b/docs/api/qiskit/0.41/qobj.md @@ -14,14 +14,10 @@ python_api_name: qiskit.qobj -`qiskit.qobj¶` +`qiskit.qobj` ## Base - - -`¶` - | | | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | | [`Qobj`](qiskit.qobj.Qobj "qiskit.qobj.Qobj")(\[qobj\_id, config, experiments, header]) | A backwards compat alias for QasmQobj. | @@ -30,10 +26,6 @@ python_api_name: qiskit.qobj ## Qasm - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | | [`QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.QasmQobj")(\[qobj\_id, config, experiments, header]) | A QASM Qobj. | @@ -46,10 +38,6 @@ python_api_name: qiskit.qobj ## Pulse - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | | [`PulseQobj`](qiskit.qobj.PulseQobj "qiskit.qobj.PulseQobj")(qobj\_id, config, experiments\[, header]) | A Pulse Qobj. | diff --git a/docs/api/qiskit/0.41/qpy.md b/docs/api/qiskit/0.41/qpy.md index 3c63cf355d3..18e6a699eaa 100644 --- a/docs/api/qiskit/0.41/qpy.md +++ b/docs/api/qiskit/0.41/qpy.md @@ -14,16 +14,12 @@ python_api_name: qiskit.qpy -`qiskit.qpy¶` +`qiskit.qpy` QPY is a binary serialization format for [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") and [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") objects that is designed to be cross-platform, Python version agnostic, and backwards compatible moving forward. QPY should be used if you need a mechanism to save or copy between systems a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") that preserves the full Qiskit object structure (except for custom attributes defined outside of Qiskit code). This differs from other serialization formats like [OpenQASM](https://github.com/openqasm/openqasm) (2.0 or 3.0) which has a different abstraction model and can result in a loss of information contained in the original circuit (or is unable to represent some aspects of the Qiskit objects) or Python’s [pickle](https://docs.python.org/3/library/pickle.html) which will preserve the Qiskit object exactly but will only work for a single Qiskit version (it is also [potentially insecure](https://docs.python.org/3/library/pickle.html#module-pickle)). ## Using QPY - - -`¶` - Using QPY is defined to be straightforward and mirror the user API of the serializers in Python’s standard library, `pickle` and `json`. There are 2 user facing functions: [`qiskit.qpy.dump()`](qiskit.qpy.dump "qiskit.qpy.dump") and [`qiskit.qpy.load()`](qiskit.qpy.load "qiskit.qpy.load") which are used to dump QPY data to a file object and load circuits from QPY data in a file object respectively. For example: ```python @@ -55,14 +51,14 @@ and then loading that file will return a list with all the circuits > > twenty\_new\_bells = qpy.load(fd) -### API documentation[¶](#api-documentation "Permalink to this headline") +### API documentation | | | | ----------------------------------------------------------------------------------------- | ------------------------------- | | [`load`](qiskit.qpy.load "qiskit.qpy.load")(file\_obj\[, metadata\_deserializer]) | Load a QPY binary file | | [`dump`](qiskit.qpy.dump "qiskit.qpy.dump")(programs, file\_obj\[, metadata\_serializer]) | Write QPY binary data to a file | -### QPY Compatibility[¶](#qpy-compatibility "Permalink to this headline") +### QPY Compatibility The QPY format is designed to be backwards compatible moving forward. This means you should be able to load a QPY with any newer Qiskit version than the one that generated it. However, loading a QPY file with an older Qiskit version is not supported and may not work. @@ -72,10 +68,6 @@ For example, if you generated a QPY file using qiskit-terra 0.18.1 you could loa ## QPY Format - - -`¶` - The QPY serialization format is a portable cross-platform binary serialization format for [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects in Qiskit. The basic file format is as follows: A QPY file (or memory object) always starts with the following 7 byte UTF8 string: `QISKIT` which is immediately followed by the overall file header. The contents of the file header as defined as a C struct are: @@ -100,7 +92,7 @@ There is a circuit payload for each circuit (where the total number is dictated -### Version 6[¶](#version-6 "Permalink to this headline") +### Version 6 Version 6 adds support for `ScalableSymbolicPulse`. These objects are saved and read like SymbolicPulse objects, and the class name is added to the data to correctly handle the class selection. @@ -121,7 +113,7 @@ The only change compared to [Version 5](#qpy-version-5) is the addition of class -### Version 5[¶](#version-5 "Permalink to this headline") +### Version 5 Version 5 changes from [Version 4](#qpy-version-4) by adding support for `ScheduleBlock` and changing two payloads the INSTRUCTION metadata payload and the CUSTOM\_INSTRUCTION block. These now have new fields to better account for [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") objects in a circuit. In addition, new payload MAP\_ITEM is defined to implement the [MAPPING](#qpy-mapping) block. @@ -146,7 +138,7 @@ immediately follows the file header block to represent the program type stored i -#### SCHEDULE\_BLOCK[¶](#schedule-block "Permalink to this headline") +#### SCHEDULE\_BLOCK [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") is first supported in QPY Version 5. This allows users to save pulse programs in the QPY binary format as follows: @@ -165,7 +157,7 @@ with open('schedule.qpy', 'rb') as fd: Note that circuit and schedule block are serialized and deserialized through the same QPY interface. Input data type is implicitly analyzed and no extra option is required to save the schedule block. -#### SCHEDULE\_BLOCK\_HEADER[¶](#schedule-block-header "Permalink to this headline") +#### SCHEDULE\_BLOCK\_HEADER [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") block starts with the following header: @@ -208,7 +200,7 @@ The operands of these instances can be serialized through the standard QPY value -#### CHANNEL[¶](#channel "Permalink to this headline") +#### CHANNEL Channel block starts with channel subtype `char` that maps an object data to [`Channel`](pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") subclass. Mapping is defined as follows: @@ -223,7 +215,7 @@ The key is immediately followed by the channel index serialized as the INSTRUCTI -#### Waveform[¶](#waveform "Permalink to this headline") +#### Waveform Waveform block starts with WAVEFORM header: @@ -239,7 +231,7 @@ which is followed by `data_size` bytes of complex `ndarray` binary generated by -#### SymbolicPulse[¶](#symbolicpulse "Permalink to this headline") +#### SymbolicPulse SymbolicPulse block starts with SYMBOLIC\_PULSE header: @@ -259,7 +251,7 @@ To uniquely specify a pulse instance, we also need to store the associated param -#### MAPPING[¶](#mapping "Permalink to this headline") +#### MAPPING The MAPPING is a representation for arbitrary mapping object. This is a fixed length [SEQUENCE](#qpy-sequence) of key-value pair represented by the MAP\_ITEM payload. @@ -277,7 +269,7 @@ which is immediately followed by the `key_size` utf8 bytes representing the dict -#### CIRCUIT\_CALIBRATIONS[¶](#circuit-calibrations "Permalink to this headline") +#### CIRCUIT\_CALIBRATIONS The CIRCUIT\_CALIBRATIONS block is a dictionary to define pulse calibrations of the custom instruction set. This block starts with the following CALIBRATION header: @@ -300,7 +292,7 @@ struct { The calibration definition header is then followed by `name_size` utf8 bytes of the gate name, `num_qubits` length of integers representing a sequence of qubits, and `num_params` length of INSTRUCTION\_PARAM payload for parameters associated to the custom instruction. The `type` indicates the class of pulse program which is either, in pricinple, [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") or [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule"). As of QPY Version 5, only [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") payload is supported. Finally, [SCHEDULE\_BLOCK](#qpy-schedule-block) payload is packed for each CALIBRATION\_DEF entry. -#### INSTRUCTION[¶](#instruction "Permalink to this headline") +#### INSTRUCTION The INSTRUCTION block was modified to add two new fields `num_ctrl_qubits` and `ctrl_state` which are used to model the [`ControlledGate.num_ctrl_qubits`](qiskit.circuit.ControlledGate#num_ctrl_qubits "qiskit.circuit.ControlledGate.num_ctrl_qubits") and [`ControlledGate.ctrl_state`](qiskit.circuit.ControlledGate#ctrl_state "qiskit.circuit.ControlledGate.ctrl_state") attributes. The new payload packed struct format is: @@ -321,7 +313,7 @@ struct { The rest of the instruction payload is the same. You can refer to [INSTRUCTIONS](#qpy-instructions) for the details of the full payload. -#### CUSTOM\_INSTRUCTION[¶](#custom-instruction "Permalink to this headline") +#### CUSTOM\_INSTRUCTION The CUSTOM\_INSTRUCTION block in QPY version 5 adds a new field `base_gate_size` which is used to define the size of the [`qiskit.circuit.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object stored in the `ControlledGate.base_gate` attribute for a custom [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") object. With this change the CUSTOM\_INSTRUCTION metadata block becomes: @@ -349,7 +341,7 @@ Additionally an addition value for `type` is added `'c'` which is used to indica -### Version 4[¶](#version-4 "Permalink to this headline") +### Version 4 Version 4 is identical to [Version 3](#qpy-version-3) except that it adds 2 new type strings to the INSTRUCTION\_PARAM struct, `z` to represent `None` (which is encoded as no data), `q` to represent a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") (which is encoded as a QPY circuit), `r` to represent a `range` of integers (which is encoded as a [RANGE](#qpy-range-pack)), and `t` to represent a `sequence` (which is encoded as defined by [SEQUENCE](#qpy-sequence)). Additionally, version 4 changes the type of register index mapping array from `uint32_t` to `int64_t`. If the values of any of the array elements are negative they represent a register bit that is not present in the circuit. @@ -369,7 +361,7 @@ which just adds the `in_circuit` field which represents whether the register is -#### RANGE[¶](#range "Permalink to this headline") +#### RANGE A RANGE is a representation of a `range` object. It is defined as: @@ -383,7 +375,7 @@ struct { -#### SEQUENCE[¶](#sequence "Permalink to this headline") +#### SEQUENCE A SEQUENCE is a reprentation of a arbitrary sequence object. As sequence are just fixed length containers of arbitrary python objects their QPY can’t fully represent any sequence, but as long as the contents in a sequence are other QPY serializable types for the INSTRUCTION\_PARAM payload the `sequence` object can be serialized. @@ -399,13 +391,13 @@ followed by `size` elements that are INSTRUCTION\_PARAM payloads, where each of -### Version 3[¶](#version-3 "Permalink to this headline") +### Version 3 Version 3 of the QPY format is identical to [Version 2](#qpy-version-2) except that it defines a struct format to represent a [`PauliEvolutionGate`](qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate") natively in QPY. To accomplish this the [CUSTOM\_DEFINITIONS](#qpy-custom-definition) struct now supports a new type value `'p'` to represent a [`PauliEvolutionGate`](qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate"). Enties in the custom instructions tables have unique name generated that start with the string `"###PauliEvolutionGate_"` followed by a uuid string. This gate name is reservered in QPY and if you have a custom [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") object with a definition set and that name prefix it will error. If it’s of type `'p'` the data payload is defined as follows: -#### PAULI\_EVOLUTION[¶](#pauli-evolution "Permalink to this headline") +#### PAULI\_EVOLUTION This represents the high level [`PauliEvolutionGate`](qiskit.circuit.library.PauliEvolutionGate "qiskit.circuit.library.PauliEvolutionGate") @@ -423,7 +415,7 @@ This is immediately followed by `operator_count` elements defined by the [SPARSE -#### SPARSE\_PAULI\_OP\_LIST\_ELEM[¶](#sparse-pauli-op-list-elem "Permalink to this headline") +#### SPARSE\_PAULI\_OP\_LIST\_ELEM This represents an instance of [`PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.PauliSumOp"). @@ -439,7 +431,7 @@ Version 3 of the QPY format also defines a struct format to represent a `Paramet -#### PARAMETER\_VECTOR\_ELEMENT[¶](#parameter-vector-element "Permalink to this headline") +#### PARAMETER\_VECTOR\_ELEMENT A PARAMETER\_VECTOR\_ELEMENT represents a `ParameterVectorElement` object the data for a INSTRUCTION\_PARAM. The contents of the PARAMETER\_VECTOR\_ELEMENT are defined as: @@ -456,7 +448,7 @@ which is immediately followed by `vector_name_size` utf8 bytes representing the -#### PARAMETER\_EXPR[¶](#parameter-expr "Permalink to this headline") +#### PARAMETER\_EXPR Additionally, since QPY format version v3 distinguishes between a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") and `ParameterVectorElement` the payload for a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") needs to be updated to distinguish between the types. The following is the modified payload format which is mostly identical to the format in Version 1 and [Version 2](#qpy-version-2) but just modifies the `map_elements` struct to include a symbol type field. @@ -483,11 +475,11 @@ The `symbol_type` key determines the payload type of the symbol representation f -### Version 2[¶](#version-2 "Permalink to this headline") +### Version 2 Version 2 of the QPY format is identical to version 1 except for the HEADER section is slightly different. You can refer to the [Version 1](#qpy-version-1) section for the details on the rest of the payload format. -#### HEADER[¶](#header "Permalink to this headline") +#### HEADER The contents of HEADER are defined as a C struct are: @@ -509,9 +501,9 @@ This is immediately followed by `name_size` bytes of utf8 data for the name of t -### Version 1[¶](#version-1 "Permalink to this headline") +### Version 1 -#### HEADER[¶](#id4 "Permalink to this headline") +#### HEADER The contents of HEADER as defined as a C struct are: @@ -530,13 +522,13 @@ struct { This is immediately followed by `name_size` bytes of utf8 data for the name of the circuit. -#### METADATA[¶](#metadata "Permalink to this headline") +#### METADATA The METADATA field is a UTF8 encoded JSON string. After reading the HEADER (which is a fixed size at the start of the QPY file) and the `name` string you then read the `metadata_size` number of bytes and parse the JSON to get the metadata for the circuit. -#### REGISTERS[¶](#registers "Permalink to this headline") +#### REGISTERS The contents of REGISTERS is a number of REGISTER object. If num\_registers is > 0 then after reading METADATA you read that number of REGISTER structs defined as: @@ -576,7 +568,7 @@ qc = QuantumCircuit(qr2) -#### CUSTOM\_DEFINITIONS[¶](#custom-definitions "Permalink to this headline") +#### CUSTOM\_DEFINITIONS This section specifies custom definitions for any of the instructions in the circuit. @@ -607,7 +599,7 @@ If `custom_definition` is `True` that means that the immediately following `size -#### INSTRUCTIONS[¶](#instructions "Permalink to this headline") +#### INSTRUCTIONS The contents of INSTRUCTIONS is a list of INSTRUCTION metadata objects @@ -654,7 +646,7 @@ After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. -#### PARAMETER[¶](#parameter "Permalink to this headline") +#### PARAMETER A PARAMETER represents a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object the data for a INSTRUCTION\_PARAM. The contents of the PARAMETER are defined as: @@ -669,7 +661,7 @@ which is immediately followed by `name_size` utf8 bytes representing the paramet -#### PARAMETER\_EXPR[¶](#qpy-param-expr "Permalink to this headline") +#### PARAMETER\_EXPR A PARAMETER\_EXPR represents a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object that the data for an INSTRUCTION\_PARAM. The contents of a PARAMETER\_EXPR are defined as: @@ -695,7 +687,7 @@ Which is followed immediately by `PARAMETER` object (both the struct and utf8 na -#### COMPLEX[¶](#complex "Permalink to this headline") +#### COMPLEX When representing a double precision complex value in QPY the following struct is used: diff --git a/docs/api/qiskit/0.41/quantum_info.md b/docs/api/qiskit/0.41/quantum_info.md index d46d0318a76..4b8b39535fc 100644 --- a/docs/api/qiskit/0.41/quantum_info.md +++ b/docs/api/qiskit/0.41/quantum_info.md @@ -14,14 +14,10 @@ python_api_name: qiskit.quantum_info -`qiskit.quantum_info¶` +`qiskit.quantum_info` ## Operators - - -`¶` - | | | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | | [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")(data\[, input\_dims, output\_dims]) | Matrix operator class | @@ -37,10 +33,6 @@ python_api_name: qiskit.quantum_info ## States - - -`¶` - | | | | ----------------------------------------------------------------------------------------------------------------- | ---------------------- | | [`Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector")(data\[, dims]) | Statevector class | @@ -49,10 +41,6 @@ python_api_name: qiskit.quantum_info ## Channels - - -`¶` - | | | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | [`Choi`](qiskit.quantum_info.Choi "qiskit.quantum_info.Choi")(data\[, input\_dims, output\_dims]) | Choi-matrix representation of a Quantum Channel. | @@ -64,10 +52,6 @@ python_api_name: qiskit.quantum_info ## Measures - - -`¶` - | | | | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | | [`average_gate_fidelity`](qiskit.quantum_info.average_gate_fidelity "qiskit.quantum_info.average_gate_fidelity")(channel\[, target, ...]) | Return the average gate fidelity of a noisy quantum channel. | @@ -83,10 +67,6 @@ python_api_name: qiskit.quantum_info ## Utility Functions - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | | [`partial_trace`](qiskit.quantum_info.partial_trace "qiskit.quantum_info.partial_trace")(state, qargs) | Return reduced density matrix by tracing out part of quantum state. | @@ -94,10 +74,6 @@ python_api_name: qiskit.quantum_info ## Random - - -`¶` - | | | | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | | [`random_statevector`](qiskit.quantum_info.random_statevector "qiskit.quantum_info.random_statevector")(dims\[, seed]) | Generator a random Statevector. | @@ -114,10 +90,6 @@ python_api_name: qiskit.quantum_info ## Analysis - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | | [`hellinger_distance`](qiskit.quantum_info.hellinger_distance "qiskit.quantum_info.hellinger_distance")(dist\_p, dist\_q) | Computes the Hellinger distance between two counts distributions. | @@ -125,10 +97,6 @@ python_api_name: qiskit.quantum_info ## Synthesis - - -`¶` - | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis, use\_dag]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | diff --git a/docs/api/qiskit/0.41/result.md b/docs/api/qiskit/0.41/result.md index 6680f0d4f98..062a05cbe9b 100644 --- a/docs/api/qiskit/0.41/result.md +++ b/docs/api/qiskit/0.41/result.md @@ -14,7 +14,7 @@ python_api_name: qiskit.result -`qiskit.result¶` +`qiskit.result` | | | | ----------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | @@ -27,10 +27,6 @@ python_api_name: qiskit.result ## Distributions - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | | [`ProbDistribution`](qiskit.result.ProbDistribution "qiskit.result.ProbDistribution")(data\[, shots]) | A generic dict-like class for probability distributions. | @@ -38,20 +34,12 @@ python_api_name: qiskit.result ## Expectation values - - -`¶` - | | | | ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | | [`sampled_expectation_value`](qiskit.result.sampled_expectation_value "qiskit.result.sampled_expectation_value")(dist, oper) | Computes expectation value from a sampled distribution | ## Mitigation - - -`¶` - | | | | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | | [`BaseReadoutMitigator`](qiskit.result.BaseReadoutMitigator "qiskit.result.BaseReadoutMitigator")() | Base readout error mitigator class. | diff --git a/docs/api/qiskit/0.41/scheduler.md b/docs/api/qiskit/0.41/scheduler.md index b2c51870f2a..643fc7490e4 100644 --- a/docs/api/qiskit/0.41/scheduler.md +++ b/docs/api/qiskit/0.41/scheduler.md @@ -14,7 +14,7 @@ python_api_name: qiskit.scheduler -`qiskit.scheduler¶` +`qiskit.scheduler` A circuit scheduler compiles a circuit program to a pulse program. diff --git a/docs/api/qiskit/0.41/synthesis.md b/docs/api/qiskit/0.41/synthesis.md index c00e3eee889..2c583d37a3c 100644 --- a/docs/api/qiskit/0.41/synthesis.md +++ b/docs/api/qiskit/0.41/synthesis.md @@ -14,14 +14,10 @@ python_api_name: qiskit.synthesis -`qiskit.synthesis¶` +`qiskit.synthesis` ## Evolution Synthesis - - -`¶` - | | | | ---------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | [`EvolutionSynthesis`](qiskit.synthesis.EvolutionSynthesis "qiskit.synthesis.EvolutionSynthesis")() | Interface for evolution synthesis algorithms. | @@ -33,10 +29,6 @@ python_api_name: qiskit.synthesis ## Linear Function Synthesis - - -`¶` - | | | | ----------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | [`synth_cnot_count_full_pmh`](qiskit.synthesis.synth_cnot_count_full_pmh "qiskit.synthesis.synth_cnot_count_full_pmh")(state\[, section\_size]) | Synthesize linear reversible circuits for all-to-all architecture using Patel, Markov and Hayes method. | @@ -44,10 +36,6 @@ python_api_name: qiskit.synthesis ## Permutation Synthesis - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | | [`synth_permutation_depth_lnn_kms`](qiskit.synthesis.synth_permutation_depth_lnn_kms "qiskit.synthesis.synth_permutation_depth_lnn_kms")(pattern) | Synthesize a permutation circuit for a linear nearest-neighbor architecture using the Kutin, Moulton, Smithline method. | @@ -56,10 +44,6 @@ python_api_name: qiskit.synthesis ## Clifford Synthesis - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`synth_clifford_full`](qiskit.synthesis.synth_clifford_full "qiskit.synthesis.synth_clifford_full")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | @@ -70,10 +54,6 @@ python_api_name: qiskit.synthesis ## CNOTDihedral Synthesis - - -`¶` - | | | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | [`synth_cnotdihedral_full`](qiskit.synthesis.synth_cnotdihedral_full "qiskit.synthesis.synth_cnotdihedral_full")(elem) | Decompose a CNOTDihedral element into a QuantumCircuit. | @@ -82,10 +62,6 @@ python_api_name: qiskit.synthesis ## Discrete Basis Synthesis - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | | [`SolovayKitaevDecomposition`](qiskit.synthesis.SolovayKitaevDecomposition "qiskit.synthesis.SolovayKitaevDecomposition")(\[...]) | The Solovay Kitaev discrete decomposition algorithm. | diff --git a/docs/api/qiskit/0.41/synthesis_aqc.md b/docs/api/qiskit/0.41/synthesis_aqc.md index 95bebd01cfb..74f581f1e0e 100644 --- a/docs/api/qiskit/0.41/synthesis_aqc.md +++ b/docs/api/qiskit/0.41/synthesis_aqc.md @@ -14,16 +14,12 @@ python_api_name: qiskit.transpiler.synthesis.aqc -`qiskit.transpiler.synthesis.aqc¶` +`qiskit.transpiler.synthesis.aqc` Implementation of Approximate Quantum Compiler as described in the paper \[1]. ## Interface - - -`¶` - The main public interface of this module is reached by passing `unitary_synthesis_method='aqc'` to [`transpile`](qiskit.compiler.transpile "qiskit.compiler.transpile"). This will swap the synthesis method to use [`AQCSynthesisPlugin`](qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin "qiskit.transpiler.synthesis.aqc.AQCSynthesisPlugin"). The individual classes are: | | | @@ -39,10 +35,6 @@ The main public interface of this module is reached by passing `unitary_synthesi ## Mathematical Detail - - -`¶` - We are interested in compiling a quantum circuit, which we formalize as finding the best circuit representation in terms of an ordered gate sequence of a target unitary matrix $U\in U(d)$, with some additional hardware constraints. In particular, we look at representations that could be constrained in terms of hardware connectivity, as well as gate depth, and we choose a gate basis in terms of CNOT and rotation gates. We recall that the combination of CNOT and rotation gates is universal in $SU(d)$ and therefore it does not limit compilation. To properly define what we mean by best circuit representation, we define the metric as the Frobenius norm between the unitary matrix of the compiled circuit $V$ and the target unitary matrix $U$, i.e., $\|V - U\|_{\mathrm{F}}$. This choice is motivated by mathematical programming considerations, and it is related to other formulations that appear in the literature. Let’s take a look at the problem in more details. @@ -134,7 +126,7 @@ This uses a helper function, [`make_cnot_network`](#qiskit.transpiler.synthesis. -`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)` +`make_cnot_network(num_qubits, network_layout='spin', connectivity_type='full', depth=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/transpiler/synthesis/aqc/cnot_structures.py "view source code") Generates a network consisting of building blocks each containing a CNOT gate and possibly some single-qubit ones. This network models a quantum operator in question. Note, each building block has 2 input and outputs corresponding to a pair of qubits. What we actually return here is a chain of indices of qubit pairs shared by every building block in a row. diff --git a/docs/api/qiskit/0.41/tools.md b/docs/api/qiskit/0.41/tools.md index 532091bc90e..4753744ad4e 100644 --- a/docs/api/qiskit/0.41/tools.md +++ b/docs/api/qiskit/0.41/tools.md @@ -12,14 +12,10 @@ python_api_name: qiskit.tools -`qiskit.tools¶` +`qiskit.tools` ## Parallel Routines - - -`¶` - A helper function for calling a custom function with python `ProcessPoolExecutor`. Tasks can be executed in parallel using this function. It has a built-in event publisher to show the progress of the parallel tasks. | | | @@ -28,10 +24,6 @@ A helper function for calling a custom function with python `ProcessPoolExecutor ## Monitoring - - -`¶` - A helper module to get IBM backend information and submitted job status. | | | @@ -42,11 +34,11 @@ A helper module to get IBM backend information and submitted job status. -### Events ([`qiskit.tools.events`](#module-qiskit.tools.events "qiskit.tools.events"))[¶](#events-qiskit-tools-events "Permalink to this headline") +### Events ([`qiskit.tools.events`](#module-qiskit.tools.events "qiskit.tools.events")) A helper component for publishing and subscribing to events. -#### TextProgressBar[¶](#textprogressbar "Permalink to this headline") +#### TextProgressBar A text based progress bar, which also enables Jupyter magics. diff --git a/docs/api/qiskit/0.41/tools_jupyter.md b/docs/api/qiskit/0.41/tools_jupyter.md index 7d74b9fabaa..e369aba3727 100644 --- a/docs/api/qiskit/0.41/tools_jupyter.md +++ b/docs/api/qiskit/0.41/tools_jupyter.md @@ -14,16 +14,12 @@ python_api_name: qiskit.tools.jupyter -`qiskit.tools.jupyter¶` +`qiskit.tools.jupyter` A Collection of Jupyter magic functions and tools that extend the functionality of Qiskit. ## Overview of all available backends - - -`¶` - ```python from qiskit.providers.ibmq import IBMQ import qiskit.tools.jupyter @@ -36,10 +32,6 @@ IBMQ.load_account() ## Detailed information on a single backend - - -`¶` - ```python from qiskit.providers.ibmq import IBMQ import qiskit.tools.jupyter @@ -53,10 +45,6 @@ backend ## Load Qiskit Job Watcher - - -`¶` - ```python import qiskit.tools.jupyter %qiskit_job_watcher @@ -64,10 +52,6 @@ import qiskit.tools.jupyter ## HTMLProgressBar - - -`¶` - ```python import numpy as np from qiskit.tools.parallel import parallel_map @@ -79,10 +63,6 @@ parallel_map(np.sin, np.linspace(0,10,100)); ## Qiskit version table - - -`¶` - ```python import qiskit.tools.jupyter %qiskit_version_table @@ -90,10 +70,6 @@ import qiskit.tools.jupyter ## Qiskit copyright - - -`¶` - ```python import qiskit.tools.jupyter %qiskit_copyright @@ -101,10 +77,6 @@ import qiskit.tools.jupyter ## Monospaced output - - -`¶` - ```python import qiskit.tools.jupyter %monospaced_output diff --git a/docs/api/qiskit/0.41/transpiler.md b/docs/api/qiskit/0.41/transpiler.md index d4329af169d..3b79b759e2c 100644 --- a/docs/api/qiskit/0.41/transpiler.md +++ b/docs/api/qiskit/0.41/transpiler.md @@ -14,14 +14,10 @@ python_api_name: qiskit.transpiler -`qiskit.transpiler¶` +`qiskit.transpiler` ## Overview - - -`¶` - Transpilation is the process of rewriting a given input circuit to match the topology of a specific quantum device, and/or to optimize the circuit for execution on present day noisy quantum systems. Most circuits must undergo a series of transformations that make them compatible with a given target device, and optimize them to reduce the effects of noise on the resulting outcomes. Rewriting quantum circuits to match hardware constraints and optimizing for performance can be far from trivial. The flow of logic in the rewriting tool chain need not be linear, and can often have iterative sub-loops, conditional branches, and other complex behaviors. That being said, the standard compilation flow follows the structure given below: @@ -43,10 +39,6 @@ When using [`transpile()`](qiskit.compiler.transpile "qiskit.compiler.transpile" ## Working with Preset Pass Managers - - -`¶` - Qiskit includes functions to build preset [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") objects. These preset passmanagers are used by the [`transpile()`](qiskit.compiler.transpile "qiskit.compiler.transpile") function for each optimization level. There are 4 optimization levels ranging from 0 to 3, where higher optimization levels take more time and computational effort but may yield a more optimal circuit. Optimization level 0 is intended for device characterization experiments and, as such, only maps the input circuit to the constraints of the target backend, without performing any optimizations. Optimization level 3 spends the most effort to optimize the circuit. However, as many of the optimization techniques in the transpiler are heuristic based, spending more computational effort does not always result in an improvement in the quality of the output circuit. If you’d like to work directly with a preset pass manager you can use the [`generate_preset_pass_manager()`](qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager") function to easily generate one. For example: @@ -96,10 +88,6 @@ Then when [`run()`](qiskit.transpiler.StagedPassManager#run "qiskit.transpiler.S ## Custom Pass Managers - - -`¶` - In addition to modifying preset pass managers, it is also possible to construct a pass manager to build an entirely custom pipeline for transforming input circuits. You can leverage the [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager") class directly to do this. You can define arbitrary stage names and populate them with a [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") instance. For example: ```python @@ -132,10 +120,6 @@ The [Stage Generator Functions](transpiler_preset#stage-generators) functions ma ## Representing Quantum Computers - - -`¶` - To be able to compile a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") for a specific backend, the transpiler needs a specialized representation of that backend, including its constraints, instruction set, qubit properties, and more, to be able to compile and optimize effectively. While the [`BackendV2`](qiskit.providers.BackendV2 "qiskit.providers.BackendV2") class defines an interface for querying and interacting with backends, its scope is larger than just the transpiler’s needs including managing job submission and potentially interfacing with remote services. The specific information needed by the transpiler is described by the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") class For example, to construct a simple [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") object, one can iteratively add descriptions of the instructions it supports: @@ -422,15 +406,11 @@ target.build_coupling_map('cz').draw() ## Transpiler Stage Details - - -`¶` - Below are a description of the default transpiler stages and the problems they solve. The default passes used for each stage are described, but the specifics are configurable via the `*_method` keyword arguments for the [`transpile()`](qiskit.compiler.transpile "qiskit.compiler.transpile") and [`generate_preset_pass_manager()`](qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager") functions which can be used to override the methods described in this section. -### Translation Stage[¶](#translation-stage "Permalink to this headline") +### Translation Stage When writing a quantum circuit you are free to use any quantum gate (unitary operator) that you like, along with a collection of non-gate operations such as qubit measurements and reset operations. However, most quantum devices only natively support a handful of quantum gates and non-gate operations. The allowed instructions for a given backend can be found by querying the [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") for the devices: @@ -523,7 +503,7 @@ It is important to highlight two special cases: -### Layout Stage[¶](#layout-stage "Permalink to this headline") +### Layout Stage Quantum circuits are abstract entities whose qubits are “virtual” representations of actual qubits used in computations. We need to be able to map these virtual qubits in a one-to-one manner to the “physical” qubits in an actual quantum device. @@ -625,7 +605,7 @@ plot_circuit_layout(my_ghz, backend) -### Routing Stage[¶](#routing-stage "Permalink to this headline") +### Routing Stage In order to implement a 2-qubit gate between qubits in a quantum circuit that are not directly connected on a quantum device, one or more swap gates must be inserted into the circuit to move the qubit states around until they are adjacent on the device gate map. Each swap gate typically represents an expensive and noisy operation to perform. Thus, finding the minimum number of swap gates needed to map a circuit onto a given device, is an important step (if not the most important) in the whole execution process. @@ -669,7 +649,7 @@ Typically, following the swap mapper, the routing stage in the preset pass manag -### Optimization Stage[¶](#optimization-stage "Permalink to this headline") +### Optimization Stage Decomposing quantum circuits into the basis gate set of the target device, and the addition of swap gates needed to match hardware topology, conspire to increase the depth and gate count of quantum circuits. Fortunately many routines for optimizing circuits by combining or eliminating gates exist. In some cases these methods are so effective the output circuits have lower depth than the inputs. In other cases, not much can be done, and the computation may be difficult to perform on noisy devices. Different gate optimizations are turned on with different `optimization_level` values. Below we show the benefits gained from setting the optimization level higher: @@ -717,7 +697,7 @@ plt.show() -### Scheduling Stage[¶](#scheduling-stage "Permalink to this headline") +### Scheduling Stage After the circuit has been translated to the target basis, mapped to the device, and optimized, a scheduling phase can be applied to optionally account for all the idle time in the circuit. At a high level the scheduling can be thought of as inserting delays into the circuit to account for idle time on the qubits between the execution of instructions. For example, if we start with a circuit such as: @@ -747,11 +727,11 @@ You can see here that the transpiler inserted [`Delay`](qiskit.circuit.Delay "qi The scheduling of a circuit involves two parts, analysis and constraint mapping followed by a padding pass. The first part requires running a scheduling analysis pass such as `ALAPSchedulingAnalysis` or `ASAPSchedulingAnalysis` which analyzes the circuit and records the start time of each instruction in the circuit using a scheduling algorithm (“as late as possible” for `ALAPSchedulingAnalysis` and “as soon as possible” for `ASAPSchedulingAnalysis`) in the property set. Once the circuit has an initial scheduling additional passes can be run to account for any timing constraints on the target backend, such as alignment constraints. This is typically done with the [`ConstrainedReschedule`](qiskit.transpiler.passes.ConstrainedReschedule "qiskit.transpiler.passes.ConstrainedReschedule") pass which will adjust the scheduling set in the property set to the constraints of the target backend. Once all the scheduling and adjustments/rescheduling are finished a padding pass, such as [`PadDelay`](qiskit.transpiler.passes.PadDelay "qiskit.transpiler.passes.PadDelay") or [`PadDynamicalDecoupling`](qiskit.transpiler.passes.PadDynamicalDecoupling "qiskit.transpiler.passes.PadDynamicalDecoupling") is run to insert the instructions into the circuit, which completes the scheduling. -#### Scheduling Analysis with control flow instructions[¶](#scheduling-analysis-with-control-flow-instructions "Permalink to this headline") +#### Scheduling Analysis with control flow instructions When scheduling analysis passes run there are additional constraints on classical conditions and control flow instructions in a circuit. This section covers the details of these additional constraints that any scheduling pass will need to account for. -##### Policy of topological node ordering in scheduling[¶](#policy-of-topological-node-ordering-in-scheduling "Permalink to this headline") +##### Policy of topological node ordering in scheduling The DAG representation of `QuantumCircuit` respects the node ordering also in the classical register wires, though theoretically two conditional instructions conditioned on the same register could commute, i.e. read-access to the classical register doesn’t change its state. @@ -777,7 +757,7 @@ c: 1/══════════════════╡ c_0=0x1 ╞╡ c_ Note that this scheduling might be inefficient in some cases, because the second conditional operation can start without waiting the delay of 100 dt. However, such optimization should be done by another pass, otherwise scheduling may break topological ordering of the original circuit. -##### Realistic control flow scheduling respecting for microarchitecture[¶](#realistic-control-flow-scheduling-respecting-for-microarchitecture "Permalink to this headline") +##### Realistic control flow scheduling respecting for microarchitecture In the dispersive QND readout scheme, qubit is measured with microwave stimulus to qubit (Q) followed by resonator ring-down (depopulation). This microwave signal is recorded in the buffer memory (B) with hardware kernel, then a discriminated (D) binary value is moved to the classical register (C). The sequence from t0 to t1 of the measure instruction interval might be modeled as follows: @@ -896,18 +876,14 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor ## Transpiler API - - -`¶` - -### Transpiler Target[¶](#transpiler-target "Permalink to this headline") +### Transpiler Target | | | | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target")(\[description, num\_qubits, dt, ...]) | The intent of the `Target` object is to inform Qiskit's compiler about the constraints of a particular backend so the compiler can compile an input circuit to something that works and is optimized for a device. | | [`InstructionProperties`](qiskit.transpiler.InstructionProperties "qiskit.transpiler.InstructionProperties")(\[duration, error, ...]) | A representation of the properties of a gate implementation. | -### Pass Manager Construction[¶](#pass-manager-construction "Permalink to this headline") +### Pass Manager Construction | | | | ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | @@ -919,34 +895,34 @@ See [https://arxiv.org/abs/2102.01682](https://arxiv.org/abs/2102.01682) for mor | [`ConditionalController`](qiskit.transpiler.ConditionalController "qiskit.transpiler.ConditionalController")(passes\[, options, ...]) | Implements a set of passes under a certain condition. | | [`DoWhileController`](qiskit.transpiler.DoWhileController "qiskit.transpiler.DoWhileController")(passes\[, options, do\_while]) | Implements a set of passes in a do-while loop. | -### Layout and Topology[¶](#layout-and-topology "Permalink to this headline") +### Layout and Topology | | | | ------------------------------------------------------------------------------------------------------------ | ----------------------------------------- | | [`Layout`](qiskit.transpiler.Layout "qiskit.transpiler.Layout")(\[input\_dict]) | Two-ways dict to represent a Layout. | | [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")(\[couplinglist, description]) | Directed graph specifying fixed coupling. | -### Scheduling[¶](#scheduling "Permalink to this headline") +### Scheduling | | | | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | | [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations")(\[instruction\_durations, dt]) | Helper class to provide durations of instructions for scheduling. | -### Fenced Objects[¶](#fenced-objects "Permalink to this headline") +### Fenced Objects | | | | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | | [`FencedDAGCircuit`](qiskit.transpiler.FencedDAGCircuit "qiskit.transpiler.FencedDAGCircuit")(dag\_circuit\_instance) | A dag circuit that cannot be modified (via remove\_op\_node) | | [`FencedPropertySet`](qiskit.transpiler.FencedPropertySet "qiskit.transpiler.FencedPropertySet")(property\_set\_instance) | A property set that cannot be written (via \_\_setitem\_\_) | -### Abstract Passes[¶](#abstract-passes "Permalink to this headline") +### Abstract Passes | | | | ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.TransformationPass")(\*args, \*\*kwargs) | A transformation pass: change DAG, not property set. | | [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.AnalysisPass")(\*args, \*\*kwargs) | An analysis pass: change property set, not DAG. | -### Exceptions[¶](#exceptions "Permalink to this headline") +### Exceptions | | | | ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | diff --git a/docs/api/qiskit/0.41/transpiler_builtin_plugins.md b/docs/api/qiskit/0.41/transpiler_builtin_plugins.md index 8ddab6a9d46..d152ba50648 100644 --- a/docs/api/qiskit/0.41/transpiler_builtin_plugins.md +++ b/docs/api/qiskit/0.41/transpiler_builtin_plugins.md @@ -1,6 +1,6 @@ -# Built-in Transpiler Synthesis Plugins[¶](#built-in-transpiler-synthesis-plugins "Permalink to this headline") +# Built-in Transpiler Synthesis Plugins * [Approximate Quantum Compiler (`qiskit.transpiler.synthesis.aqc`)](synthesis_aqc) diff --git a/docs/api/qiskit/0.41/transpiler_passes.md b/docs/api/qiskit/0.41/transpiler_passes.md index 870db7bb572..806363f3aad 100644 --- a/docs/api/qiskit/0.41/transpiler_passes.md +++ b/docs/api/qiskit/0.41/transpiler_passes.md @@ -14,14 +14,10 @@ python_api_name: qiskit.transpiler.passes -`qiskit.transpiler.passes¶` +`qiskit.transpiler.passes` ## Layout Selection (Placement) - - -`¶` - | | | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | [`SetLayout`](qiskit.transpiler.passes.SetLayout "qiskit.transpiler.passes.SetLayout")(\*args, \*\*kwargs) | Set the `layout` property to the given layout. | @@ -38,10 +34,6 @@ python_api_name: qiskit.transpiler.passes ## Routing - - -`¶` - | | | | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | | [`BasicSwap`](qiskit.transpiler.passes.BasicSwap "qiskit.transpiler.passes.BasicSwap")(\*args, \*\*kwargs) | Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. | @@ -53,10 +45,6 @@ python_api_name: qiskit.transpiler.passes ## Basis Change - - -`¶` - | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | [`Unroller`](qiskit.transpiler.passes.Unroller "qiskit.transpiler.passes.Unroller")(\*args, \*\*kwargs) | Unroll a circuit to a given basis. | @@ -68,10 +56,6 @@ python_api_name: qiskit.transpiler.passes ## Optimizations - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`Optimize1qGates`](qiskit.transpiler.passes.Optimize1qGates "qiskit.transpiler.passes.Optimize1qGates")(\*args, \*\*kwargs) | Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. | @@ -100,10 +84,6 @@ python_api_name: qiskit.transpiler.passes ## Calibration - - -`¶` - | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | | [`PulseGates`](qiskit.transpiler.passes.PulseGates "qiskit.transpiler.passes.PulseGates")(inst\_map) | Pulse gate adding pass. | @@ -112,10 +92,6 @@ python_api_name: qiskit.transpiler.passes ## Scheduling - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------- | | [`TimeUnitConversion`](qiskit.transpiler.passes.TimeUnitConversion "qiskit.transpiler.passes.TimeUnitConversion")(inst\_durations) | Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. | @@ -134,10 +110,6 @@ python_api_name: qiskit.transpiler.passes ## Circuit Analysis - - -`¶` - | | | | ---------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | | [`Width`](qiskit.transpiler.passes.Width "qiskit.transpiler.passes.Width")(\*args, \*\*kwargs) | Calculate the width of a DAG circuit. | @@ -150,10 +122,6 @@ python_api_name: qiskit.transpiler.passes ## Synthesis - - -`¶` - | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [`UnitarySynthesis`](qiskit.transpiler.passes.UnitarySynthesis "qiskit.transpiler.passes.UnitarySynthesis")(\[basis\_gates, ...]) | Synthesize gates according to their basis gates. | @@ -165,10 +133,6 @@ python_api_name: qiskit.transpiler.passes ## Synthesis Plugins - - -`¶` - | | | | ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | | [`SolovayKitaevSynthesis`](qiskit.transpiler.passes.SolovayKitaevSynthesis "qiskit.transpiler.passes.SolovayKitaevSynthesis")() | A Solovay-Kitaev Qiskit unitary synthesis plugin. | @@ -178,20 +142,12 @@ python_api_name: qiskit.transpiler.passes ## Post Layout (Post transpile qubit selection) - - -`¶` - | | | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | [`VF2PostLayout`](qiskit.transpiler.passes.VF2PostLayout "qiskit.transpiler.passes.VF2PostLayout")(\*args, \*\*kwargs) | A pass for choosing a Layout after transpilation of a circuit onto a Coupling graph, as a subgraph isomorphism problem, solved by VF2++. | ## Additional Passes - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | [`CheckMap`](qiskit.transpiler.passes.CheckMap "qiskit.transpiler.passes.CheckMap")(\*args, \*\*kwargs) | Check if a DAG circuit is already mapped to a coupling map. | diff --git a/docs/api/qiskit/0.41/transpiler_plugins.md b/docs/api/qiskit/0.41/transpiler_plugins.md index 170f44d6a0e..0cf61a4085a 100644 --- a/docs/api/qiskit/0.41/transpiler_plugins.md +++ b/docs/api/qiskit/0.41/transpiler_plugins.md @@ -14,7 +14,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers.plugin -`qiskit.transpiler.preset_passmanagers.plugin¶` +`qiskit.transpiler.preset_passmanagers.plugin` This module defines the plugin interface for providing custom stage implementations for the preset pass managers and the [`transpile()`](qiskit.compiler.transpile "qiskit.compiler.transpile") function. This enables external Python packages to provide [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") objects that can be used for each named stage. @@ -26,10 +26,6 @@ For details on how to instead write plugins for transpiler synthesis methods, se ## Plugin Stages - - -`¶` - Currently, there are 6 stages in the preset pass managers, all of which actively load external plugins via corresponding entry points. | Stage Name | Entry Point | Reserved Names | Description and expectations | @@ -43,10 +39,6 @@ Currently, there are 6 stages in the preset pass managers, all of which actively ## Writing Plugins - - -`¶` - To write a pass manager stage plugin there are 2 main steps. The first step is to create a subclass of the abstract plugin class [`PassManagerStagePlugin`](qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin "qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin") which is used to define how the [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") for the stage will be constructed. For example, to create a `layout` stage plugin that just runs [`VF2Layout`](qiskit.transpiler.passes.VF2Layout "qiskit.transpiler.passes.VF2Layout") (with increasing amount of trials, depending on the optimization level) and falls back to using [`TrivialLayout`](qiskit.transpiler.passes.TrivialLayout "qiskit.transpiler.passes.TrivialLayout") if `VF2Layout` is unable to find a perfect layout: ```python @@ -98,10 +90,6 @@ Note that the entry point `name = path` is a single string not a Python expressi ## Plugin API - - -`¶` - | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`PassManagerStagePlugin`](qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin "qiskit.transpiler.preset_passmanagers.plugin.PassManagerStagePlugin")() | A `PassManagerStagePlugin` is a plugin interface object for using custom stages in [`transpile()`](qiskit.compiler.transpile "qiskit.compiler.transpile"). | diff --git a/docs/api/qiskit/0.41/transpiler_preset.md b/docs/api/qiskit/0.41/transpiler_preset.md index 8fecb299d7c..da22096e9c6 100644 --- a/docs/api/qiskit/0.41/transpiler_preset.md +++ b/docs/api/qiskit/0.41/transpiler_preset.md @@ -14,7 +14,7 @@ python_api_name: qiskit.transpiler.preset_passmanagers -`qiskit.transpiler.preset_passmanagers¶` +`qiskit.transpiler.preset_passmanagers` This module contains functions for generating the preset pass managers for the transpiler. The preset pass managers are instances of [`StagedPassManager`](qiskit.transpiler.StagedPassManager "qiskit.transpiler.StagedPassManager") which are used to execute the circuit transformations as part of Qiskit’s compiler inside the [`transpile()`](qiskit.compiler.transpile "qiskit.compiler.transpile") function at the different optimization levels. The functionality here is divided into two parts, the first includes the functions used generate the entire pass manager which is used by [`transpile()`](qiskit.compiler.transpile "qiskit.compiler.transpile") ([Preset Pass Manager Generation](#preset-pass-manager-generators)) and the second includes functions which are used to build (either entirely or in part) the stages which the preset pass managers are composed of ([Stage Generator Functions](#stage-generators)). @@ -22,10 +22,6 @@ This module contains functions for generating the preset pass managers for the t ## Preset Pass Manager Generation - - -`¶` - | | | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | [`generate_preset_pass_manager`](qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager "qiskit.transpiler.preset_passmanagers.generate_preset_pass_manager")(optimization\_level) | Generate a preset [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager") | @@ -38,10 +34,6 @@ This module contains functions for generating the preset pass managers for the t ## Stage Generator Functions - - -`¶` - | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [`generate_control_flow_options_check`](qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check "qiskit.transpiler.preset_passmanagers.common.generate_control_flow_options_check")(\[...]) | Generate a pass manager that, when run on a DAG that contains control flow, fails with an error message explaining the invalid options, and what could be used instead. | diff --git a/docs/api/qiskit/0.41/transpiler_synthesis_plugins.md b/docs/api/qiskit/0.41/transpiler_synthesis_plugins.md index 047c53b7a17..f329a67ef4e 100644 --- a/docs/api/qiskit/0.41/transpiler_synthesis_plugins.md +++ b/docs/api/qiskit/0.41/transpiler_synthesis_plugins.md @@ -14,7 +14,7 @@ python_api_name: qiskit.transpiler.passes.synthesis.plugin -`qiskit.transpiler.passes.synthesis.plugin¶` +`qiskit.transpiler.passes.synthesis.plugin` This module defines the plugin interfaces for the synthesis transpiler passes in Qiskit. These provide a hook point for external python packages to implement their own synthesis techniques and have them seamlessly exposed as opt-in options to users when they run [`transpile()`](qiskit.compiler.transpile "qiskit.compiler.transpile"). @@ -24,11 +24,7 @@ See [`qiskit.transpiler.preset_passmanagers.plugin`](transpiler_plugins#module-q ## Writing Plugins - - -`¶` - -### Unitary Synthesis Plugins[¶](#unitary-synthesis-plugins "Permalink to this headline") +### Unitary Synthesis Plugins To write a unitary synthesis plugin there are 2 main steps. The first step is to create a subclass of the abstract plugin class: [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin"). The plugin class defines the interface and contract for unitary synthesis plugins. The primary method is [`run()`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin#run "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin.run") which takes in a single positional argument, a unitary matrix as a numpy array, and is expected to return a [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") object representing the synthesized circuit from that unitary matrix. Then to inform the Qiskit transpiler about what information is necessary for the pass there are several required property methods that need to be implemented such as `supports_basis_gates` and `supports_coupling_map` depending on whether the plugin supports and/or requires that input to perform synthesis. For the full details refer to the [`UnitarySynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPlugin") documentation for all the required fields. An example plugin class would look something like: @@ -98,11 +94,11 @@ entry_points = { (note that the entry point `name = path` is a single string not a Python expression). There isn’t a limit to the number of plugins a single package can include as long as each plugin has a unique name. So a single package can expose multiple plugins if necessary. The name `default` is used by Qiskit itself and can’t be used in a plugin. -#### Unitary Synthesis Plugin Configuration[¶](#unitary-synthesis-plugin-configuration "Permalink to this headline") +#### Unitary Synthesis Plugin Configuration For some unitary synthesis plugins that expose multiple options and tunables the plugin interface has an option for users to provide a free form configuration dictionary. This will be passed through to the `run()` method as the `config` kwarg. If your plugin has these configuration options you should clearly document how a user should specify these configuration options and how they’re used as it’s a free form field. -### High-Level Synthesis Plugins[¶](#high-level-synthesis-plugins "Permalink to this headline") +### High-Level Synthesis Plugins Writing a high-level synthesis plugin is conceptually similar to writing a unitary synthesis plugin. The first step is to create a subclass of the abstract plugin class: [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin"), which defines the interface and contract for high-level synthesis plugins. The primary method is [`run()`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin#run "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.run"). It takes in a single positional argument, a “higher-level-object” to be synthesized, which is any object of type [`Operation`](qiskit.circuit.Operation "qiskit.circuit.Operation") (including, for example, [`LinearFunction`](qiskit.circuit.library.LinearFunction "qiskit.circuit.library.generalized_gates.linear_function.LinearFunction") or [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.operators.symplectic.clifford.Clifford")). The method [`run()`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin#run "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin.run") is expected to return a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object representing the synthesized circuit from that higher-level-object. It is also allowed to return `None` representing that the synthesis method is unable to synthesize the given higher-level-object. The actual synthesis of higher-level objects is performed by [`HighLevelSynthesis`](qiskit.transpiler.passes.HighLevelSynthesis "qiskit.transpiler.passes.synthesis.high_level_synthesis.HighLevelSynthesis") transpiler pass. In the near future, [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") will be extended with additional information necessary to run this transpiler pass, for instance whether the plugin supports and/or requires `coupling_map` to perform synthesis. For the full details refer to the [`HighLevelSynthesisPlugin`](qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin "qiskit.transpiler.passes.synthesis.plugin.HighLevelSynthesisPlugin") documentation for all the required fields. An example plugin class would look something like: @@ -136,21 +132,13 @@ entry_points = { ## Using Plugins - - -`¶` - To use a plugin all you need to do is install the package that includes a synthesis plugin. Then Qiskit will automatically discover the installed plugins and expose them as valid options for the appropriate [`transpile()`](qiskit.compiler.transpile "qiskit.compiler.transpile") kwargs and pass constructors. If there are any installed plugins which can’t be loaded/imported this will be logged to Python logging. To get the installed list of installed unitary synthesis plugins you can use the [`qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names()`](qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names "qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names") function. ## Plugin API - - -`¶` - -### Unitary Synthesis Plugins[¶](#id1 "Permalink to this headline") +### Unitary Synthesis Plugins | | | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | @@ -158,7 +146,7 @@ To get the installed list of installed unitary synthesis plugins you can use the | [`UnitarySynthesisPluginManager`](qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager "qiskit.transpiler.passes.synthesis.plugin.UnitarySynthesisPluginManager")() | Unitary Synthesis plugin manager class | | [`unitary_synthesis_plugin_names`](qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names "qiskit.transpiler.passes.synthesis.plugin.unitary_synthesis_plugin_names")() | Return a list of installed unitary synthesis plugin names | -### High-Level Synthesis Plugins[¶](#id2 "Permalink to this headline") +### High-Level Synthesis Plugins | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | diff --git a/docs/api/qiskit/0.41/utils.md b/docs/api/qiskit/0.41/utils.md index 7b25ee556dc..d7d6d7e59ce 100644 --- a/docs/api/qiskit/0.41/utils.md +++ b/docs/api/qiskit/0.41/utils.md @@ -14,7 +14,7 @@ python_api_name: qiskit.utils -`qiskit.utils¶` +`qiskit.utils` | | | | ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | @@ -28,10 +28,6 @@ python_api_name: qiskit.utils ## Algorithm Utilities - - -`¶` - | | | | --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | | [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | @@ -54,13 +50,13 @@ A QuantumInstance holds the Qiskit backend as well as a number of compile and ru -`qiskit.utils.optionals¶` +`qiskit.utils.optionals` Qiskit Terra, and many of the other Qiskit components, have several features that are enabled only if certain *optional* dependencies are satisfied. This module is a collection of objects that can be used to test if certain functionality is available, and optionally raise `MissingOptionalLibraryError` if the functionality is not available. -### Available Testers[¶](#available-testers "Permalink to this headline") +### Available Testers -#### Qiskit Components[¶](#qiskit-components "Permalink to this headline") +#### Qiskit Components | | | | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -69,7 +65,7 @@ Qiskit Terra, and many of the other Qiskit components, have several features tha | **HAS\_IGNIS** | `Qiskit Ignis` provides tools for quantum hardware verification, noise characterization, and error correction. | | **HAS\_TOQM** | [Qiskit TOQM](https://github.com/qiskit-toqm/qiskit-toqm) provides transpiler passes for the [Time-optimal Qubit mapping algorithm](https://doi.org/10.1145/3445814.3446706). | -#### External Python Libraries[¶](#external-python-libraries "Permalink to this headline") +#### External Python Libraries | | | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -97,7 +93,7 @@ Qiskit Terra, and many of the other Qiskit components, have several features tha | **HAS\_TWEEDLEDUM** | [Tweedledum](https://github.com/boschmitt/tweedledum) is an extension library for synthesis and optimization of circuits that may involve classical oracles. Qiskit Terra’s [`PhaseOracle`](qiskit.circuit.library.PhaseOracle "qiskit.circuit.library.PhaseOracle") uses this, which is used in turn by amplification algorithms via the [`AmplificationProblem`](qiskit.algorithms.AmplificationProblem "qiskit.algorithms.AmplificationProblem"). | | **HAS\_Z3** | [Z3](https://github.com/Z3Prover/z3) is a theorem prover, used in the [`CrosstalkAdaptiveSchedule`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule") and [`HoareOptimizer`](qiskit.transpiler.passes.HoareOptimizer "qiskit.transpiler.passes.HoareOptimizer") transpiler passes. | -#### External Command-Line Tools[¶](#external-command-line-tools "Permalink to this headline") +#### External Command-Line Tools | | | | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -105,7 +101,7 @@ Qiskit Terra, and many of the other Qiskit components, have several features tha | **HAS\_PDFLATEX** | Visualisation tools that use LaTeX in their output, such as the circuit drawers, require `pdflatex` to be available. You will generally need to ensure that you have a working LaTeX installation available, and the `qcircuit.tex` package. | | **HAS\_PDFTOCAIRO** | Visualisation tools that convert LaTeX-generated files into rasterised images use the `pdftocairo` tool. This is part of the [Poppler suite of PDF tools](https://poppler.freedesktop.org/). | -### Lazy Checker Classes[¶](#lazy-checker-classes "Permalink to this headline") +### Lazy Checker Classes Each of the lazy checkers is an instance of [`LazyDependencyManager`](#qiskit.utils.LazyDependencyManager "qiskit.utils.LazyDependencyManager") in one of its two subclasses: [`LazyImportTester`](#qiskit.utils.LazyImportTester "qiskit.utils.LazyImportTester") and [`LazySubprocessTester`](#qiskit.utils.LazySubprocessTester "qiskit.utils.LazySubprocessTester"). These should be imported from [`utils`](aer_utils#module-qiskit_aer.utils "qiskit_aer.utils") directly if required, such as: @@ -115,7 +111,7 @@ from qiskit.utils import LazyImportTester -`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)` +`LazyDependencyManager(*, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") A mananger for some optional features that are expensive to import, or to verify the existence of. @@ -244,7 +240,7 @@ Eagerly attempt to import the dependencies in this object, and raise an exceptio -`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)` +`LazyImportTester(name_map_or_modules, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") A lazy dependency tester for importable Python modules. Any required objects will only be imported at the point that this object is tested for its Boolean value. @@ -258,7 +254,7 @@ A lazy dependency tester for importable Python modules. Any required objects wil -`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)` +`LazySubprocessTester(command, *, name=None, callback=None, install=None, msg=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.23/qiskit/utils/lazy_tester.py "view source code") A lazy checker that a command-line tool is available. The command will only be run once, at the point that this object is checked for its Boolean value. diff --git a/docs/api/qiskit/0.41/utils_mitigation.md b/docs/api/qiskit/0.41/utils_mitigation.md index ecaa8bb6444..e6c9483019d 100644 --- a/docs/api/qiskit/0.41/utils_mitigation.md +++ b/docs/api/qiskit/0.41/utils_mitigation.md @@ -14,7 +14,7 @@ python_api_name: qiskit.utils.mitigation -`qiskit.utils.mitigation¶` +`qiskit.utils.mitigation` The user-facing API stability of this module is not guaranteed except for its use with the [`QuantumInstance`](qiskit.utils.QuantumInstance "qiskit.utils.QuantumInstance") (i.e. using the [`CompleteMeasFitter`](qiskit.utils.mitigation.CompleteMeasFitter "qiskit.utils.mitigation.CompleteMeasFitter") or [`TensoredMeasFitter`](qiskit.utils.mitigation.TensoredMeasFitter "qiskit.utils.mitigation.TensoredMeasFitter") classes as values for the `meas_error_mitigation_cls`). The rest of this module should be treated as an internal private API that can not be relied upon. @@ -22,10 +22,6 @@ python_api_name: qiskit.utils.mitigation ## Measurement correction - - -`¶` - The measurement calibration is used to mitigate measurement errors. The main idea is to prepare all $2^n$ basis input states and compute the probability of measuring counts in the other basis states. From these calibrations, it is possible to correct the average results of another experiment of interest. These tools are intended for use solely with the [`QuantumInstance`](qiskit.utils.QuantumInstance "qiskit.utils.QuantumInstance") class as part of [`qiskit.algorithms`](algorithms#module-qiskit.algorithms "qiskit.algorithms") and [`qiskit.opflow`](opflow#module-qiskit.opflow "qiskit.opflow"). | | | diff --git a/docs/api/qiskit/0.41/visualization.md b/docs/api/qiskit/0.41/visualization.md index d7ef18db25c..55366a412ed 100644 --- a/docs/api/qiskit/0.41/visualization.md +++ b/docs/api/qiskit/0.41/visualization.md @@ -14,7 +14,7 @@ python_api_name: qiskit.visualization -`qiskit.visualization¶` +`qiskit.visualization` The visualization module contain functions that visualizes measurement outcome counts, quantum states, circuits, pulses, devices and more. @@ -26,10 +26,6 @@ pip install 'qiskit[visualization]' ## Common Keyword Arguments - - -`¶` - Many of the figures created by visualization functions in this module are created by [Matplotlib](https://matplotlib.org/) and accept a subset of the following common arguments. Consult the individual documentation for exact details. * `title` (`str`): a text string to use for the plot title. @@ -82,17 +78,13 @@ hist.savefig('new_hist.png') ## Counts Visualizations - - -`¶` - This section contains functions that visualize measurement outcome counts. | | | | --------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | | [`plot_histogram`](qiskit.visualization.plot_histogram "qiskit.visualization.plot_histogram")(data\[, figsize, color, ...]) | Plot a histogram of input counts data. | -### Example Usage[¶](#example-usage "Permalink to this headline") +### Example Usage Here is an example of using [`plot_histogram()`](qiskit.visualization.plot_histogram "qiskit.visualization.plot_histogram") to visualize measurement outcome counts: @@ -109,10 +101,6 @@ The data can be a dictionary with bit string as key and counts as value, or more ## Distribution Visualizations - - -`¶` - This section contains functions that visualize sampled distributions. | | | @@ -121,10 +109,6 @@ This section contains functions that visualize sampled distributions. ## State Visualizations - - -`¶` - This section contains functions that visualize quantum states. | | | @@ -136,7 +120,7 @@ This section contains functions that visualize quantum states. | [`plot_state_paulivec`](qiskit.visualization.plot_state_paulivec "qiskit.visualization.plot_state_paulivec")(state\[, title, figsize, ...]) | Plot the paulivec representation of a quantum state. | | [`plot_state_qsphere`](qiskit.visualization.plot_state_qsphere "qiskit.visualization.plot_state_qsphere")(state\[, figsize, ax, ...]) | Plot the qsphere representation of a quantum state. | -### Example Usage[¶](#id1 "Permalink to this headline") +### Example Usage Here is an example of using [`plot_state_city()`](qiskit.visualization.plot_state_city "qiskit.visualization.plot_state_city") to visualize a quantum state: @@ -188,10 +172,6 @@ You can find code examples for each visualization functions on the individual fu ## Device Visualizations - - -`¶` - | | | | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | | [`plot_gate_map`](qiskit.visualization.plot_gate_map "qiskit.visualization.plot_gate_map")(backend\[, figsize, ...]) | Plots the gate map of a device. | @@ -201,10 +181,6 @@ You can find code examples for each visualization functions on the individual fu ## Circuit Visualizations - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | | [`circuit_drawer`](qiskit.visualization.circuit_drawer "qiskit.visualization.circuit_drawer")(circuit\[, scale, filename, ...]) | Draw the quantum circuit. | @@ -212,30 +188,18 @@ You can find code examples for each visualization functions on the individual fu ## DAG Visualizations - - -`¶` - | | | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | [`dag_drawer`](qiskit.visualization.dag_drawer "qiskit.visualization.dag_drawer")(dag\[, scale, filename, style]) | Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. | ## Pass Manager Visualizations - - -`¶` - | | | | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | | [`pass_manager_drawer`](qiskit.visualization.pass_manager_drawer "qiskit.visualization.pass_manager_drawer")(pass\_manager\[, ...]) | Draws the pass manager. | ## Pulse Visualizations - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------- | | [`pulse_drawer`](qiskit.visualization.pulse_drawer "qiskit.visualization.pulse_drawer")(program\[, style, backend, ...]) | Generate visualization data for pulse programs. | @@ -245,40 +209,24 @@ You can find code examples for each visualization functions on the individual fu ## Timeline Visualizations - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- | | [`timeline_drawer`](qiskit.visualization.timeline_drawer "qiskit.visualization.timeline_drawer")(program\[, style, ...]) | Generate visualization data for scheduled circuit programs. | ## Single Qubit State Transition Visualizations - - -`¶` - | | | | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | | [`visualize_transition`](qiskit.visualization.visualize_transition "qiskit.visualization.visualize_transition")(circuit\[, trace, ...]) | Creates animation showing transitions between states of a single qubit by applying quantum gates. | ## Array/Matrix Visualizations - - -`¶` - | | | | ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | | [`array_to_latex`](qiskit.visualization.array_to_latex "qiskit.visualization.array_to_latex")(array\[, precision, prefix, ...]) | Latex representation of a complex numpy array (with dimension 1 or 2) | ## Exceptions - - -`¶` - | | | | -------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | | [`VisualizationError`](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError")(\*message) | For visualization specific errors. |